{ "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.5.1" }, "servers": [{ "url": "https://demo-frontends.shopware.store/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/advanced-search-action": { "get": { "tags": ["Advanced Search Action"], "summary": "List with basic information of Advanced Search Action resources.", "description": "", "operationId": "getAdvancedSearchActionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Action resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-action?limit=25" }, "last": { "example": "/advanced-search-action?limit=25&page=11" }, "next": { "example": "/advanced-search-action?limit=25&page=4" }, "prev": { "example": "/advanced-search-action?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Action"], "summary": "Create a new Advanced Search Action resources.", "description": "", "operationId": "createAdvancedSearchAction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-action": { "post": { "tags": ["Advanced Search Action"], "summary": "Search for the Advanced Search Action resources.", "description": "", "operationId": "searchAdvancedSearchAction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-action/{id}": { "get": { "tags": ["Advanced Search Action"], "summary": "Detailed information about a Advanced Search Action resource.", "description": "", "operationId": "getAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Action"], "summary": "Delete a Advanced Search Action resource.", "description": "", "operationId": "deleteAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Action"], "summary": "Partially update information about a Advanced Search Action resource.", "description": "", "operationId": "updateAdvancedSearchAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Action resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-action": { "post": { "tags": ["Advanced Search Action"], "summary": "Aggregate for the Advanced Search Action resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-action-search-term": { "get": { "tags": ["Advanced Search Action Search Term"], "summary": "List with basic information of Advanced Search Action Search Term resources.", "description": "", "operationId": "getAdvancedSearchActionSearchTermList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Action Search Term resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-action-search-term?limit=25" }, "last": { "example": "/advanced-search-action-search-term?limit=25&page=11" }, "next": { "example": "/advanced-search-action-search-term?limit=25&page=4" }, "prev": { "example": "/advanced-search-action-search-term?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Action Search Term"], "summary": "Create a new Advanced Search Action Search Term resources.", "description": "", "operationId": "createAdvancedSearchActionSearchTerm", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-action-search-term": { "post": { "tags": ["Advanced Search Action Search Term"], "summary": "Search for the Advanced Search Action Search Term resources.", "description": "", "operationId": "searchAdvancedSearchActionSearchTerm", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-action-search-term/{id}": { "get": { "tags": ["Advanced Search Action Search Term"], "summary": "Detailed information about a Advanced Search Action Search Term resource.", "description": "", "operationId": "getAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Action Search Term"], "summary": "Delete a Advanced Search Action Search Term resource.", "description": "", "operationId": "deleteAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Action Search Term"], "summary": "Partially update information about a Advanced Search Action Search Term resource.", "description": "", "operationId": "updateAdvancedSearchActionSearchTerm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_action_search_term", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Action Search Term resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-action-search-term": { "post": { "tags": ["Advanced Search Action Search Term"], "summary": "Aggregate for the Advanced Search Action Search Term resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchActionSearchTerm", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchActionSearchTerm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-boosting": { "get": { "tags": ["Advanced Search Boosting"], "summary": "List with basic information of Advanced Search Boosting resources.", "description": "", "operationId": "getAdvancedSearchBoostingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Boosting resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-boosting?limit=25" }, "last": { "example": "/advanced-search-boosting?limit=25&page=11" }, "next": { "example": "/advanced-search-boosting?limit=25&page=4" }, "prev": { "example": "/advanced-search-boosting?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Boosting"], "summary": "Create a new Advanced Search Boosting resources.", "description": "", "operationId": "createAdvancedSearchBoosting", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-boosting": { "post": { "tags": ["Advanced Search Boosting"], "summary": "Search for the Advanced Search Boosting resources.", "description": "", "operationId": "searchAdvancedSearchBoosting", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-boosting/{id}": { "get": { "tags": ["Advanced Search Boosting"], "summary": "Detailed information about a Advanced Search Boosting resource.", "description": "", "operationId": "getAdvancedSearchBoosting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_boosting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Boosting"], "summary": "Delete a Advanced Search Boosting resource.", "description": "", "operationId": "deleteAdvancedSearchBoosting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_boosting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Boosting"], "summary": "Partially update information about a Advanced Search Boosting resource.", "description": "", "operationId": "updateAdvancedSearchBoosting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_boosting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Boosting resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-boosting": { "post": { "tags": ["Advanced Search Boosting"], "summary": "Aggregate for the Advanced Search Boosting resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchBoosting", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchBoosting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-config": { "get": { "tags": ["Advanced Search Config"], "summary": "List with basic information of Advanced Search Config resources.", "description": "", "operationId": "getAdvancedSearchConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Config resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-config?limit=25" }, "last": { "example": "/advanced-search-config?limit=25&page=11" }, "next": { "example": "/advanced-search-config?limit=25&page=4" }, "prev": { "example": "/advanced-search-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Config"], "summary": "Create a new Advanced Search Config resources.", "description": "", "operationId": "createAdvancedSearchConfig", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-config": { "post": { "tags": ["Advanced Search Config"], "summary": "Search for the Advanced Search Config resources.", "description": "", "operationId": "searchAdvancedSearchConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-config/{id}": { "get": { "tags": ["Advanced Search Config"], "summary": "Detailed information about a Advanced Search Config resource.", "description": "", "operationId": "getAdvancedSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Config"], "summary": "Delete a Advanced Search Config resource.", "description": "", "operationId": "deleteAdvancedSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Config"], "summary": "Partially update information about a Advanced Search Config resource.", "description": "", "operationId": "updateAdvancedSearchConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-config": { "post": { "tags": ["Advanced Search Config"], "summary": "Aggregate for the Advanced Search Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-config-field": { "get": { "tags": ["Advanced Search Config Field"], "summary": "List with basic information of Advanced Search Config Field resources.", "description": "", "operationId": "getAdvancedSearchConfigFieldList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Config Field resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-config-field?limit=25" }, "last": { "example": "/advanced-search-config-field?limit=25&page=11" }, "next": { "example": "/advanced-search-config-field?limit=25&page=4" }, "prev": { "example": "/advanced-search-config-field?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Config Field"], "summary": "Create a new Advanced Search Config Field resources.", "description": "", "operationId": "createAdvancedSearchConfigField", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-config-field": { "post": { "tags": ["Advanced Search Config Field"], "summary": "Search for the Advanced Search Config Field resources.", "description": "", "operationId": "searchAdvancedSearchConfigField", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-config-field/{id}": { "get": { "tags": ["Advanced Search Config Field"], "summary": "Detailed information about a Advanced Search Config Field resource.", "description": "", "operationId": "getAdvancedSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Config Field"], "summary": "Delete a Advanced Search Config Field resource.", "description": "", "operationId": "deleteAdvancedSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Config Field"], "summary": "Partially update information about a Advanced Search Config Field resource.", "description": "", "operationId": "updateAdvancedSearchConfigField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_config_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Config Field resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-config-field": { "post": { "tags": ["Advanced Search Config Field"], "summary": "Aggregate for the Advanced Search Config Field resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchConfigField", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchConfigField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-entity-stream": { "get": { "tags": ["Advanced Search Entity Stream"], "summary": "List with basic information of Advanced Search Entity Stream resources.", "description": "", "operationId": "getAdvancedSearchEntityStreamList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Entity Stream resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-entity-stream?limit=25" }, "last": { "example": "/advanced-search-entity-stream?limit=25&page=11" }, "next": { "example": "/advanced-search-entity-stream?limit=25&page=4" }, "prev": { "example": "/advanced-search-entity-stream?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Entity Stream"], "summary": "Create a new Advanced Search Entity Stream resources.", "description": "", "operationId": "createAdvancedSearchEntityStream", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchEntityStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-entity-stream": { "post": { "tags": ["Advanced Search Entity Stream"], "summary": "Search for the Advanced Search Entity Stream resources.", "description": "", "operationId": "searchAdvancedSearchEntityStream", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchEntityStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-entity-stream/{id}": { "get": { "tags": ["Advanced Search Entity Stream"], "summary": "Detailed information about a Advanced Search Entity Stream resource.", "description": "", "operationId": "getAdvancedSearchEntityStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchEntityStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Entity Stream"], "summary": "Delete a Advanced Search Entity Stream resource.", "description": "", "operationId": "deleteAdvancedSearchEntityStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Entity Stream"], "summary": "Partially update information about a Advanced Search Entity Stream resource.", "description": "", "operationId": "updateAdvancedSearchEntityStream", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Entity Stream resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchEntityStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-entity-stream": { "post": { "tags": ["Advanced Search Entity Stream"], "summary": "Aggregate for the Advanced Search Entity Stream resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchEntityStream", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchEntityStream", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-entity-stream-filter": { "get": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "List with basic information of Advanced Search Entity Stream Filter resources.", "description": "", "operationId": "getAdvancedSearchEntityStreamFilterList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Entity Stream Filter resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-entity-stream-filter?limit=25" }, "last": { "example": "/advanced-search-entity-stream-filter?limit=25&page=11" }, "next": { "example": "/advanced-search-entity-stream-filter?limit=25&page=4" }, "prev": { "example": "/advanced-search-entity-stream-filter?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Create a new Advanced Search Entity Stream Filter resources.", "description": "", "operationId": "createAdvancedSearchEntityStreamFilter", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchEntityStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-entity-stream-filter": { "post": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Search for the Advanced Search Entity Stream Filter resources.", "description": "", "operationId": "searchAdvancedSearchEntityStreamFilter", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchEntityStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-entity-stream-filter/{id}": { "get": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Detailed information about a Advanced Search Entity Stream Filter resource.", "description": "", "operationId": "getAdvancedSearchEntityStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchEntityStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Delete a Advanced Search Entity Stream Filter resource.", "description": "", "operationId": "deleteAdvancedSearchEntityStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Partially update information about a Advanced Search Entity Stream Filter resource.", "description": "", "operationId": "updateAdvancedSearchEntityStreamFilter", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_entity_stream_filter", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Entity Stream Filter resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchEntityStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-entity-stream-filter": { "post": { "tags": ["Advanced Search Entity Stream Filter"], "summary": "Aggregate for the Advanced Search Entity Stream Filter resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchEntityStreamFilter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchEntityStreamFilter", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-synonym": { "get": { "tags": ["Advanced Search Synonym"], "summary": "List with basic information of Advanced Search Synonym resources.", "description": "", "operationId": "getAdvancedSearchSynonymList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Advanced Search Synonym resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/advanced-search-synonym?limit=25" }, "last": { "example": "/advanced-search-synonym?limit=25&page=11" }, "next": { "example": "/advanced-search-synonym?limit=25&page=4" }, "prev": { "example": "/advanced-search-synonym?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Advanced Search Synonym"], "summary": "Create a new Advanced Search Synonym resources.", "description": "", "operationId": "createAdvancedSearchSynonym", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchSynonym", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/advanced-search-synonym": { "post": { "tags": ["Advanced Search Synonym"], "summary": "Search for the Advanced Search Synonym resources.", "description": "", "operationId": "searchAdvancedSearchSynonym", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 AdvancedSearchSynonym", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/advanced-search-synonym/{id}": { "get": { "tags": ["Advanced Search Synonym"], "summary": "Detailed information about a Advanced Search Synonym resource.", "description": "", "operationId": "getAdvancedSearchSynonym", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_synonym", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of AdvancedSearchSynonym", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Advanced Search Synonym"], "summary": "Delete a Advanced Search Synonym resource.", "description": "", "operationId": "deleteAdvancedSearchSynonym", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_synonym", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Advanced Search Synonym"], "summary": "Partially update information about a Advanced Search Synonym resource.", "description": "", "operationId": "updateAdvancedSearchSynonym", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the advanced_search_synonym", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Advanced Search Synonym resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } }, "responses": { "200": { "description": "Detail of AdvancedSearchSynonym", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/advanced-search-synonym": { "post": { "tags": ["Advanced Search Synonym"], "summary": "Aggregate for the Advanced Search Synonym resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAdvancedSearchSynonym", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AdvancedSearchSynonym", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchSynonym" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/app-flow-event": { "post": { "tags": ["App Flow Event"], "summary": "Aggregate for the App Flow Event resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateAppFlowEvent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/app-payment-method": { "get": { "tags": ["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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/b2b-business-partner": { "get": { "tags": ["B2b Business Partner"], "summary": "List with basic information of B2b Business Partner resources.", "description": "", "operationId": "getB2bBusinessPartnerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Business Partner resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-business-partner?limit=25" }, "last": { "example": "/b2b-business-partner?limit=25&page=11" }, "next": { "example": "/b2b-business-partner?limit=25&page=4" }, "prev": { "example": "/b2b-business-partner?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Business Partner"], "summary": "Create a new B2b Business Partner resources.", "description": "", "operationId": "createB2bBusinessPartner", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-business-partner": { "post": { "tags": ["B2b Business Partner"], "summary": "Search for the B2b Business Partner resources.", "description": "", "operationId": "searchB2bBusinessPartner", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-business-partner/{id}": { "get": { "tags": ["B2b Business Partner"], "summary": "Detailed information about a B2b Business Partner resource.", "description": "", "operationId": "getB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Business Partner"], "summary": "Delete a B2b Business Partner resource.", "description": "", "operationId": "deleteB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Business Partner"], "summary": "Partially update information about a B2b Business Partner resource.", "description": "", "operationId": "updateB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Business Partner resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-business-partner": { "post": { "tags": ["B2b Business Partner"], "summary": "Aggregate for the B2b Business Partner resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bBusinessPartner", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-advanced-product-catalogs": { "get": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "List with basic information of B2b Components Advanced Product Catalogs resources.", "description": "Available since: 6.7.1.0", "operationId": "getB2bComponentsAdvancedProductCatalogsList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Advanced Product Catalogs resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-advanced-product-catalogs?limit=25" }, "last": { "example": "/b2b-components-advanced-product-catalogs?limit=25&page=11" }, "next": { "example": "/b2b-components-advanced-product-catalogs?limit=25&page=4" }, "prev": { "example": "/b2b-components-advanced-product-catalogs?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Create a new B2b Components Advanced Product Catalogs resources.", "description": "Available since: 6.7.1.0", "operationId": "createB2bComponentsAdvancedProductCatalogs", "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/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-advanced-product-catalogs": { "post": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Search for the B2b Components Advanced Product Catalogs resources.", "description": "Available since: 6.7.1.0", "operationId": "searchB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-advanced-product-catalogs/{id}": { "get": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Detailed information about a B2b Components Advanced Product Catalogs resource.", "description": "Available since: 6.7.1.0", "operationId": "getB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Delete a B2b Components Advanced Product Catalogs resource.", "description": "Available since: 6.7.1.0", "operationId": "deleteB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Partially update information about a B2b Components Advanced Product Catalogs resource.", "description": "Available since: 6.7.1.0", "operationId": "updateB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Advanced Product Catalogs resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-advanced-product-catalogs": { "post": { "tags": ["B2b Components Advanced Product Catalogs"], "summary": "Aggregate for the B2b Components Advanced Product Catalogs resources.", "description": "Available since: 6.7.1.0", "operationId": "aggregateB2bComponentsAdvancedProductCatalogs", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-approval-rule": { "get": { "tags": ["B2b Components Approval Rule"], "summary": "List with basic information of B2b Components Approval Rule resources.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsApprovalRuleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Approval 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/B2bComponentsApprovalRule" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-approval-rule?limit=25" }, "last": { "example": "/b2b-components-approval-rule?limit=25&page=11" }, "next": { "example": "/b2b-components-approval-rule?limit=25&page=4" }, "prev": { "example": "/b2b-components-approval-rule?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Approval Rule"], "summary": "Create a new B2b Components Approval Rule resources.", "description": "Available since: 6.6.0.0", "operationId": "createB2bComponentsApprovalRule", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-approval-rule": { "post": { "tags": ["B2b Components Approval Rule"], "summary": "Search for the B2b Components Approval Rule resources.", "description": "Available since: 6.6.0.0", "operationId": "searchB2bComponentsApprovalRule", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-approval-rule/{id}": { "get": { "tags": ["B2b Components Approval Rule"], "summary": "Detailed information about a B2b Components Approval Rule resource.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Approval Rule"], "summary": "Delete a B2b Components Approval Rule resource.", "description": "Available since: 6.6.0.0", "operationId": "deleteB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Approval Rule"], "summary": "Partially update information about a B2b Components Approval Rule resource.", "description": "Available since: 6.6.0.0", "operationId": "updateB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Approval Rule resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-approval-rule": { "post": { "tags": ["B2b Components Approval Rule"], "summary": "Aggregate for the B2b Components Approval Rule resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsApprovalRule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-approval-rule-app-script-condition": { "get": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", "description": "Available since: 6.6.3.0", "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Approval Rule 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/B2bComponentsApprovalRuleAppScriptCondition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-approval-rule-app-script-condition?limit=25" }, "last": { "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" }, "next": { "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" }, "prev": { "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", "description": "Available since: 6.6.3.0", "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", "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/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-approval-rule-app-script-condition": { "post": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", "description": "Available since: 6.6.3.0", "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-approval-rule-app-script-condition/{id}": { "get": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", "description": "Available since: 6.6.3.0", "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", "description": "Available since: 6.6.3.0", "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", "description": "Available since: 6.6.3.0", "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_approval_rule_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 B2b Components Approval Rule App Script Condition resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-approval-rule-app-script-condition": { "post": { "tags": ["B2b Components Approval Rule App Script Condition"], "summary": "Aggregate for the B2b Components Approval Rule App Script Condition resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsApprovalRuleAppScriptCondition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-budget": { "get": { "tags": ["B2b Components Budget"], "summary": "List with basic information of B2b Components Budget resources.", "description": "Available since: 6.7.4.0", "operationId": "getB2bComponentsBudgetList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Budget resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-budget?limit=25" }, "last": { "example": "/b2b-components-budget?limit=25&page=11" }, "next": { "example": "/b2b-components-budget?limit=25&page=4" }, "prev": { "example": "/b2b-components-budget?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Budget"], "summary": "Create a new B2b Components Budget resources.", "description": "Available since: 6.7.4.0", "operationId": "createB2bComponentsBudget", "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/B2bComponentsBudget" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-budget": { "post": { "tags": ["B2b Components Budget"], "summary": "Search for the B2b Components Budget resources.", "description": "Available since: 6.7.4.0", "operationId": "searchB2bComponentsBudget", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-budget/{id}": { "get": { "tags": ["B2b Components Budget"], "summary": "Detailed information about a B2b Components Budget resource.", "description": "Available since: 6.7.4.0", "operationId": "getB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Budget"], "summary": "Delete a B2b Components Budget resource.", "description": "Available since: 6.7.4.0", "operationId": "deleteB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Budget"], "summary": "Partially update information about a B2b Components Budget resource.", "description": "Available since: 6.7.4.0", "operationId": "updateB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Budget resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-budget": { "post": { "tags": ["B2b Components Budget"], "summary": "Aggregate for the B2b Components Budget resources.", "description": "Available since: 6.7.4.0", "operationId": "aggregateB2bComponentsBudget", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsBudget" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-employee-wishlist": { "get": { "tags": ["B2b Components Employee Wishlist"], "summary": "List with basic information of B2b Components Employee Wishlist resources.", "description": "", "operationId": "getB2bComponentsEmployeeWishlistList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Employee 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/B2bComponentsEmployeeWishlist" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-employee-wishlist?limit=25" }, "last": { "example": "/b2b-components-employee-wishlist?limit=25&page=11" }, "next": { "example": "/b2b-components-employee-wishlist?limit=25&page=4" }, "prev": { "example": "/b2b-components-employee-wishlist?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Employee Wishlist"], "summary": "Create a new B2b Components Employee Wishlist resources.", "description": "", "operationId": "createB2bComponentsEmployeeWishlist", "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/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-employee-wishlist": { "post": { "tags": ["B2b Components Employee Wishlist"], "summary": "Search for the B2b Components Employee Wishlist resources.", "description": "", "operationId": "searchB2bComponentsEmployeeWishlist", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-employee-wishlist/{id}": { "get": { "tags": ["B2b Components Employee Wishlist"], "summary": "Detailed information about a B2b Components Employee Wishlist resource.", "description": "", "operationId": "getB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Employee Wishlist"], "summary": "Delete a B2b Components Employee Wishlist resource.", "description": "", "operationId": "deleteB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Employee Wishlist"], "summary": "Partially update information about a B2b Components Employee Wishlist resource.", "description": "", "operationId": "updateB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_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 B2b Components Employee Wishlist resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-employee-wishlist": { "post": { "tags": ["B2b Components Employee Wishlist"], "summary": "Aggregate for the B2b Components Employee Wishlist resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsEmployeeWishlist", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-employee-wishlist-product": { "get": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "List with basic information of B2b Components Employee Wishlist Product resources.", "description": "", "operationId": "getB2bComponentsEmployeeWishlistProductList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Employee 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/B2bComponentsEmployeeWishlistProduct" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-employee-wishlist-product?limit=25" }, "last": { "example": "/b2b-components-employee-wishlist-product?limit=25&page=11" }, "next": { "example": "/b2b-components-employee-wishlist-product?limit=25&page=4" }, "prev": { "example": "/b2b-components-employee-wishlist-product?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Create a new B2b Components Employee Wishlist Product resources.", "description": "", "operationId": "createB2bComponentsEmployeeWishlistProduct", "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/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-employee-wishlist-product": { "post": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Search for the B2b Components Employee Wishlist Product resources.", "description": "", "operationId": "searchB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-employee-wishlist-product/{id}": { "get": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Detailed information about a B2b Components Employee Wishlist Product resource.", "description": "", "operationId": "getB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Delete a B2b Components Employee Wishlist Product resource.", "description": "", "operationId": "deleteB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Partially update information about a B2b Components Employee Wishlist Product resource.", "description": "", "operationId": "updateB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_employee_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 B2b Components Employee Wishlist Product resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-employee-wishlist-product": { "post": { "tags": ["B2b Components Employee Wishlist Product"], "summary": "Aggregate for the B2b Components Employee Wishlist Product resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsEmployeeWishlistProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-organization": { "get": { "tags": ["B2b Components Organization"], "summary": "List with basic information of B2b Components Organization resources.", "description": "", "operationId": "getB2bComponentsOrganizationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Organization resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-organization?limit=25" }, "last": { "example": "/b2b-components-organization?limit=25&page=11" }, "next": { "example": "/b2b-components-organization?limit=25&page=4" }, "prev": { "example": "/b2b-components-organization?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Organization"], "summary": "Create a new B2b Components Organization resources.", "description": "", "operationId": "createB2bComponentsOrganization", "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/B2bComponentsOrganization" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-organization": { "post": { "tags": ["B2b Components Organization"], "summary": "Search for the B2b Components Organization resources.", "description": "", "operationId": "searchB2bComponentsOrganization", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-organization/{id}": { "get": { "tags": ["B2b Components Organization"], "summary": "Detailed information about a B2b Components Organization resource.", "description": "", "operationId": "getB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Organization"], "summary": "Delete a B2b Components Organization resource.", "description": "", "operationId": "deleteB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Organization"], "summary": "Partially update information about a B2b Components Organization resource.", "description": "", "operationId": "updateB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Organization resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-organization": { "post": { "tags": ["B2b Components Organization"], "summary": "Aggregate for the B2b Components Organization resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsOrganization", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-organization-customer-address": { "get": { "tags": ["B2b Components Organization Customer Address"], "summary": "List with basic information of B2b Components Organization Customer Address resources.", "description": "", "operationId": "getB2bComponentsOrganizationCustomerAddressList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Organization 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/B2bComponentsOrganizationCustomerAddress" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-organization-customer-address?limit=25" }, "last": { "example": "/b2b-components-organization-customer-address?limit=25&page=11" }, "next": { "example": "/b2b-components-organization-customer-address?limit=25&page=4" }, "prev": { "example": "/b2b-components-organization-customer-address?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Organization Customer Address"], "summary": "Create a new B2b Components Organization Customer Address resources.", "description": "", "operationId": "createB2bComponentsOrganizationCustomerAddress", "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/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-organization-customer-address": { "post": { "tags": ["B2b Components Organization Customer Address"], "summary": "Search for the B2b Components Organization Customer Address resources.", "description": "", "operationId": "searchB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-organization-customer-address/{id}": { "get": { "tags": ["B2b Components Organization Customer Address"], "summary": "Detailed information about a B2b Components Organization Customer Address resource.", "description": "", "operationId": "getB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Organization Customer Address"], "summary": "Delete a B2b Components Organization Customer Address resource.", "description": "", "operationId": "deleteB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Organization Customer Address"], "summary": "Partially update information about a B2b Components Organization Customer Address resource.", "description": "", "operationId": "updateB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_organization_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 B2b Components Organization Customer Address resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-organization-customer-address": { "post": { "tags": ["B2b Components Organization Customer Address"], "summary": "Aggregate for the B2b Components Organization Customer Address resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsOrganizationCustomerAddress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-pending-order": { "get": { "tags": ["B2b Components Pending Order"], "summary": "List with basic information of B2b Components Pending Order resources.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsPendingOrderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Pending 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/B2bComponentsPendingOrder" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-pending-order?limit=25" }, "last": { "example": "/b2b-components-pending-order?limit=25&page=11" }, "next": { "example": "/b2b-components-pending-order?limit=25&page=4" }, "prev": { "example": "/b2b-components-pending-order?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Pending Order"], "summary": "Create a new B2b Components Pending Order resources.", "description": "Available since: 6.6.0.0", "operationId": "createB2bComponentsPendingOrder", "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/B2bComponentsPendingOrder" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-pending-order": { "post": { "tags": ["B2b Components Pending Order"], "summary": "Search for the B2b Components Pending Order resources.", "description": "Available since: 6.6.0.0", "operationId": "searchB2bComponentsPendingOrder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-pending-order/{id}": { "get": { "tags": ["B2b Components Pending Order"], "summary": "Detailed information about a B2b Components Pending Order resource.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Pending Order"], "summary": "Delete a B2b Components Pending Order resource.", "description": "Available since: 6.6.0.0", "operationId": "deleteB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Pending Order"], "summary": "Partially update information about a B2b Components Pending Order resource.", "description": "Available since: 6.6.0.0", "operationId": "updateB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_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 B2b Components Pending Order resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-pending-order": { "post": { "tags": ["B2b Components Pending Order"], "summary": "Aggregate for the B2b Components Pending Order resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsPendingOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-pending-order-address": { "get": { "tags": ["B2b Components Pending Order Address"], "summary": "List with basic information of B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsPendingOrderAddressList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Pending 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/B2bComponentsPendingOrderAddress" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-pending-order-address?limit=25" }, "last": { "example": "/b2b-components-pending-order-address?limit=25&page=11" }, "next": { "example": "/b2b-components-pending-order-address?limit=25&page=4" }, "prev": { "example": "/b2b-components-pending-order-address?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Pending Order Address"], "summary": "Create a new B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", "operationId": "createB2bComponentsPendingOrderAddress", "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/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-pending-order-address": { "post": { "tags": ["B2b Components Pending Order Address"], "summary": "Search for the B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", "operationId": "searchB2bComponentsPendingOrderAddress", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-pending-order-address/{id}": { "get": { "tags": ["B2b Components Pending Order Address"], "summary": "Detailed information about a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", "operationId": "getB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Pending Order Address"], "summary": "Delete a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", "operationId": "deleteB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Pending Order Address"], "summary": "Partially update information about a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", "operationId": "updateB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_pending_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 B2b Components Pending Order Address resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-pending-order-address": { "post": { "tags": ["B2b Components Pending Order Address"], "summary": "Aggregate for the B2b Components Pending Order Address resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsPendingOrderAddress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-role": { "get": { "tags": ["B2b Components Role"], "summary": "List with basic information of B2b Components Role resources.", "description": "", "operationId": "getB2bComponentsRoleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Role resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-role?limit=25" }, "last": { "example": "/b2b-components-role?limit=25&page=11" }, "next": { "example": "/b2b-components-role?limit=25&page=4" }, "prev": { "example": "/b2b-components-role?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Role"], "summary": "Create a new B2b Components Role resources.", "description": "", "operationId": "createB2bComponentsRole", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-role": { "post": { "tags": ["B2b Components Role"], "summary": "Search for the B2b Components Role resources.", "description": "", "operationId": "searchB2bComponentsRole", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-role/{id}": { "get": { "tags": ["B2b Components Role"], "summary": "Detailed information about a B2b Components Role resource.", "description": "", "operationId": "getB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Role"], "summary": "Delete a B2b Components Role resource.", "description": "", "operationId": "deleteB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Role"], "summary": "Partially update information about a B2b Components Role resource.", "description": "", "operationId": "updateB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Role resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-role": { "post": { "tags": ["B2b Components Role"], "summary": "Aggregate for the B2b Components Role resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsRole", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsRole" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-shopping-list": { "get": { "tags": ["B2b Components Shopping List"], "summary": "List with basic information of B2b Components Shopping List resources.", "description": "Available since: 6.6.2.0", "operationId": "getB2bComponentsShoppingListList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Shopping List resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-shopping-list?limit=25" }, "last": { "example": "/b2b-components-shopping-list?limit=25&page=11" }, "next": { "example": "/b2b-components-shopping-list?limit=25&page=4" }, "prev": { "example": "/b2b-components-shopping-list?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Shopping List"], "summary": "Create a new B2b Components Shopping List resources.", "description": "Available since: 6.6.2.0", "operationId": "createB2bComponentsShoppingList", "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/B2bComponentsShoppingList" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-shopping-list": { "post": { "tags": ["B2b Components Shopping List"], "summary": "Search for the B2b Components Shopping List resources.", "description": "Available since: 6.6.2.0", "operationId": "searchB2bComponentsShoppingList", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-shopping-list/{id}": { "get": { "tags": ["B2b Components Shopping List"], "summary": "Detailed information about a B2b Components Shopping List resource.", "description": "Available since: 6.6.2.0", "operationId": "getB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Shopping List"], "summary": "Delete a B2b Components Shopping List resource.", "description": "Available since: 6.6.2.0", "operationId": "deleteB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Shopping List"], "summary": "Partially update information about a B2b Components Shopping List resource.", "description": "Available since: 6.6.2.0", "operationId": "updateB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Components Shopping List resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-shopping-list": { "post": { "tags": ["B2b Components Shopping List"], "summary": "Aggregate for the B2b Components Shopping List resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsShoppingList", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-shopping-list-line-item": { "get": { "tags": ["B2b Components Shopping List Line Item"], "summary": "List with basic information of B2b Components Shopping List Line Item resources.", "description": "Available since: 6.6.2.0", "operationId": "getB2bComponentsShoppingListLineItemList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Components Shopping List 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/B2bComponentsShoppingListLineItem" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-components-shopping-list-line-item?limit=25" }, "last": { "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" }, "next": { "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" }, "prev": { "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Create a new B2b Components Shopping List Line Item resources.", "description": "Available since: 6.6.2.0", "operationId": "createB2bComponentsShoppingListLineItem", "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/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-components-shopping-list-line-item": { "post": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Search for the B2b Components Shopping List Line Item resources.", "description": "Available since: 6.6.2.0", "operationId": "searchB2bComponentsShoppingListLineItem", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-components-shopping-list-line-item/{id}": { "get": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Detailed information about a B2b Components Shopping List Line Item resource.", "description": "Available since: 6.6.2.0", "operationId": "getB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Delete a B2b Components Shopping List Line Item resource.", "description": "Available since: 6.6.2.0", "operationId": "deleteB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Partially update information about a B2b Components Shopping List Line Item resource.", "description": "Available since: 6.6.2.0", "operationId": "updateB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_components_shopping_list_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 B2b Components Shopping List Line Item resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-components-shopping-list-line-item": { "post": { "tags": ["B2b Components Shopping List Line Item"], "summary": "Aggregate for the B2b Components Shopping List Line Item resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bComponentsShoppingListLineItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-employee": { "get": { "tags": ["B2b Employee"], "summary": "List with basic information of B2b Employee resources.", "description": "", "operationId": "getB2bEmployeeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Employee resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-employee?limit=25" }, "last": { "example": "/b2b-employee?limit=25&page=11" }, "next": { "example": "/b2b-employee?limit=25&page=4" }, "prev": { "example": "/b2b-employee?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Employee"], "summary": "Create a new B2b Employee resources.", "description": "", "operationId": "createB2bEmployee", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-employee": { "post": { "tags": ["B2b Employee"], "summary": "Search for the B2b Employee resources.", "description": "", "operationId": "searchB2bEmployee", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-employee/{id}": { "get": { "tags": ["B2b Employee"], "summary": "Detailed information about a B2b Employee resource.", "description": "", "operationId": "getB2bEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Employee"], "summary": "Delete a B2b Employee resource.", "description": "", "operationId": "deleteB2bEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Employee"], "summary": "Partially update information about a B2b Employee resource.", "description": "", "operationId": "updateB2bEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Employee resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-employee": { "post": { "tags": ["B2b Employee"], "summary": "Aggregate for the B2b Employee resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bEmployee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-order-employee": { "get": { "tags": ["B2b Order Employee"], "summary": "List with basic information of B2b Order Employee resources.", "description": "", "operationId": "getB2bOrderEmployeeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Order Employee resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-order-employee?limit=25" }, "last": { "example": "/b2b-order-employee?limit=25&page=11" }, "next": { "example": "/b2b-order-employee?limit=25&page=4" }, "prev": { "example": "/b2b-order-employee?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Order Employee"], "summary": "Create a new B2b Order Employee resources.", "description": "", "operationId": "createB2bOrderEmployee", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-order-employee": { "post": { "tags": ["B2b Order Employee"], "summary": "Search for the B2b Order Employee resources.", "description": "", "operationId": "searchB2bOrderEmployee", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-order-employee/{id}": { "get": { "tags": ["B2b Order Employee"], "summary": "Detailed information about a B2b Order Employee resource.", "description": "", "operationId": "getB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Order Employee"], "summary": "Delete a B2b Order Employee resource.", "description": "", "operationId": "deleteB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Order Employee"], "summary": "Partially update information about a B2b Order Employee resource.", "description": "", "operationId": "updateB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Order Employee resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-order-employee": { "post": { "tags": ["B2b Order Employee"], "summary": "Aggregate for the B2b Order Employee resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bOrderEmployee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bOrderEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-permission": { "get": { "tags": ["B2b Permission"], "summary": "List with basic information of B2b Permission resources.", "description": "", "operationId": "getB2bPermissionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of B2b Permission resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/b2b-permission?limit=25" }, "last": { "example": "/b2b-permission?limit=25&page=11" }, "next": { "example": "/b2b-permission?limit=25&page=4" }, "prev": { "example": "/b2b-permission?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["B2b Permission"], "summary": "Create a new B2b Permission resources.", "description": "", "operationId": "createB2bPermission", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/b2b-permission": { "post": { "tags": ["B2b Permission"], "summary": "Search for the B2b Permission resources.", "description": "", "operationId": "searchB2bPermission", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/b2b-permission/{id}": { "get": { "tags": ["B2b Permission"], "summary": "Detailed information about a B2b Permission resource.", "description": "", "operationId": "getB2bPermission", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["B2b Permission"], "summary": "Delete a B2b Permission resource.", "description": "", "operationId": "deleteB2bPermission", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["B2b Permission"], "summary": "Partially update information about a B2b Permission resource.", "description": "", "operationId": "updateB2bPermission", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a B2b Permission resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/B2bPermission" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/b2b-permission": { "post": { "tags": ["B2b Permission"], "summary": "Aggregate for the B2b Permission resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateB2bPermission", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/B2bPermission" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/ce-spatial-preview": { "get": { "tags": ["Ce Spatial Preview"], "summary": "List with basic information of Ce Spatial Preview resources.", "description": "", "operationId": "getCeSpatialPreviewList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Ce Spatial Preview resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/ce-spatial-preview?limit=25" }, "last": { "example": "/ce-spatial-preview?limit=25&page=11" }, "next": { "example": "/ce-spatial-preview?limit=25&page=4" }, "prev": { "example": "/ce-spatial-preview?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Ce Spatial Preview"], "summary": "Create a new Ce Spatial Preview resources.", "description": "", "operationId": "createCeSpatialPreview", "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/CeSpatialPreview" } } } }, "responses": { "200": { "description": "Detail of CeSpatialPreview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/ce-spatial-preview": { "post": { "tags": ["Ce Spatial Preview"], "summary": "Search for the Ce Spatial Preview resources.", "description": "", "operationId": "searchCeSpatialPreview", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 CeSpatialPreview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/ce-spatial-preview/{id}": { "get": { "tags": ["Ce Spatial Preview"], "summary": "Detailed information about a Ce Spatial Preview resource.", "description": "", "operationId": "getCeSpatialPreview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the ce_spatial_preview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CeSpatialPreview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Ce Spatial Preview"], "summary": "Delete a Ce Spatial Preview resource.", "description": "", "operationId": "deleteCeSpatialPreview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the ce_spatial_preview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Ce Spatial Preview"], "summary": "Partially update information about a Ce Spatial Preview resource.", "description": "", "operationId": "updateCeSpatialPreview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the ce_spatial_preview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Ce Spatial Preview resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CeSpatialPreview" } } } }, "responses": { "200": { "description": "Detail of CeSpatialPreview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/ce-spatial-preview": { "post": { "tags": ["Ce Spatial Preview"], "summary": "Aggregate for the Ce Spatial Preview resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCeSpatialPreview", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of CeSpatialPreview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CeSpatialPreview" } } } } } } }, "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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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-page-activity": { "get": { "tags": ["Cms Page Activity"], "summary": "List with basic information of Cms Page Activity resources.", "description": "", "operationId": "getCmsPageActivityList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The 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 Activity resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-page-activity?limit=25" }, "last": { "example": "/cms-page-activity?limit=25&page=11" }, "next": { "example": "/cms-page-activity?limit=25&page=4" }, "prev": { "example": "/cms-page-activity?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Cms Page Activity"], "summary": "Create a new Cms Page Activity resources.", "description": "", "operationId": "createCmsPageActivity", "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/CmsPageActivity" } } } }, "responses": { "200": { "description": "Detail of CmsPageActivity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-page-activity": { "post": { "tags": ["Cms Page Activity"], "summary": "Search for the Cms Page Activity resources.", "description": "", "operationId": "searchCmsPageActivity", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 CmsPageActivity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-page-activity/{id}": { "get": { "tags": ["Cms Page Activity"], "summary": "Detailed information about a Cms Page Activity resource.", "description": "", "operationId": "getCmsPageActivity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_activity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsPageActivity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Cms Page Activity"], "summary": "Delete a Cms Page Activity resource.", "description": "", "operationId": "deleteCmsPageActivity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_activity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Cms Page Activity"], "summary": "Partially update information about a Cms Page Activity resource.", "description": "", "operationId": "updateCmsPageActivity", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_activity", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "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 Activity resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsPageActivity" } } } }, "responses": { "200": { "description": "Detail of CmsPageActivity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/cms-page-activity": { "post": { "tags": ["Cms Page Activity"], "summary": "Aggregate for the Cms Page Activity resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsPageActivity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of CmsPageActivity", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageActivity" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-page-draft": { "get": { "tags": ["Cms Page Draft"], "summary": "List with basic information of Cms Page Draft resources.", "description": "", "operationId": "getCmsPageDraftList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The 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 Draft resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/cms-page-draft?limit=25" }, "last": { "example": "/cms-page-draft?limit=25&page=11" }, "next": { "example": "/cms-page-draft?limit=25&page=4" }, "prev": { "example": "/cms-page-draft?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Cms Page Draft"], "summary": "Create a new Cms Page Draft resources.", "description": "", "operationId": "createCmsPageDraft", "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/CmsPageDraft" } } } }, "responses": { "200": { "description": "Detail of CmsPageDraft", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/cms-page-draft": { "post": { "tags": ["Cms Page Draft"], "summary": "Search for the Cms Page Draft resources.", "description": "", "operationId": "searchCmsPageDraft", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 CmsPageDraft", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/cms-page-draft/{id}": { "get": { "tags": ["Cms Page Draft"], "summary": "Detailed information about a Cms Page Draft resource.", "description": "", "operationId": "getCmsPageDraft", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_draft", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CmsPageDraft", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Cms Page Draft"], "summary": "Delete a Cms Page Draft resource.", "description": "", "operationId": "deleteCmsPageDraft", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_draft", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Cms Page Draft"], "summary": "Partially update information about a Cms Page Draft resource.", "description": "", "operationId": "updateCmsPageDraft", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the cms_page_draft", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "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 Draft resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmsPageDraft" } } } }, "responses": { "200": { "description": "Detail of CmsPageDraft", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/cms-page-draft": { "post": { "tags": ["Cms Page Draft"], "summary": "Aggregate for the Cms Page Draft resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCmsPageDraft", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of CmsPageDraft", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPageDraft" } } } } } } }, "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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/custom-price": { "get": { "tags": ["Custom Price"], "summary": "List with basic information of Custom Price resources.", "description": "", "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/custom-price?limit=25" }, "last": { "example": "/custom-price?limit=25&page=11" }, "next": { "example": "/custom-price?limit=25&page=4" }, "prev": { "example": "/custom-price?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Custom Price"], "summary": "Create a new Custom Price resources.", "description": "", "operationId": "createCustomPrice", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/custom-price": { "post": { "tags": ["Custom Price"], "summary": "Search for the Custom Price resources.", "description": "", "operationId": "searchCustomPrice", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 CustomPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/custom-price/{id}": { "get": { "tags": ["Custom Price"], "summary": "Detailed information about a Custom Price resource.", "description": "", "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Custom Price"], "summary": "Delete a Custom Price resource.", "description": "", "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Custom Price"], "summary": "Partially update information about a Custom Price resource.", "description": "", "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Custom Price resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/custom-price": { "post": { "tags": ["Custom Price"], "summary": "Aggregate for the Custom Price resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer": { "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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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-specific-features": { "get": { "tags": ["Customer Specific Features"], "summary": "List with basic information of Customer Specific Features resources.", "description": "", "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/customer-specific-features?limit=25" }, "last": { "example": "/customer-specific-features?limit=25&page=11" }, "next": { "example": "/customer-specific-features?limit=25&page=4" }, "prev": { "example": "/customer-specific-features?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Customer Specific Features"], "summary": "Create a new Customer Specific Features resources.", "description": "", "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/customer-specific-features": { "post": { "tags": ["Customer Specific Features"], "summary": "Search for the Customer Specific Features resources.", "description": "", "operationId": "searchCustomerSpecificFeatures", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/customer-specific-features/{id}": { "get": { "tags": ["Customer Specific Features"], "summary": "Detailed information about a Customer Specific Features resource.", "description": "", "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Customer Specific Features"], "summary": "Delete a Customer Specific Features resource.", "description": "", "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Customer Specific Features"], "summary": "Partially update information about a Customer Specific Features resource.", "description": "", "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/customer-specific-features": { "post": { "tags": ["Customer Specific Features"], "summary": "Aggregate for the Customer Specific Features resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateCustomerSpecificFeatures", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/document-base-config-sales-channel": { "post": { "tags": ["Document Base Config Sales Channel"], "summary": "Aggregate for the Document Base Config Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDocumentBaseConfigSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/document-type": { "get": { "tags": ["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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/dsr-appointment": { "get": { "tags": ["Dsr Appointment"], "summary": "List with basic information of Dsr Appointment resources.", "description": "", "operationId": "getDsrAppointmentList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-appointment?limit=25" }, "last": { "example": "/dsr-appointment?limit=25&page=11" }, "next": { "example": "/dsr-appointment?limit=25&page=4" }, "prev": { "example": "/dsr-appointment?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Appointment"], "summary": "Create a new Dsr Appointment resources.", "description": "", "operationId": "createDsrAppointment", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-appointment": { "post": { "tags": ["Dsr Appointment"], "summary": "Search for the Dsr Appointment resources.", "description": "", "operationId": "searchDsrAppointment", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrAppointment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment/{id}": { "get": { "tags": ["Dsr Appointment"], "summary": "Detailed information about a Dsr Appointment resource.", "description": "", "operationId": "getDsrAppointment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Appointment"], "summary": "Delete a Dsr Appointment resource.", "description": "", "operationId": "deleteDsrAppointment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Appointment"], "summary": "Partially update information about a Dsr Appointment resource.", "description": "", "operationId": "updateDsrAppointment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Appointment resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointment" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-appointment": { "post": { "tags": ["Dsr Appointment"], "summary": "Aggregate for the Dsr Appointment resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrAppointment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-attendee": { "get": { "tags": ["Dsr Appointment Attendee"], "summary": "List with basic information of Dsr Appointment Attendee resources.", "description": "", "operationId": "getDsrAppointmentAttendeeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Appointment Attendee resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-appointment-attendee?limit=25" }, "last": { "example": "/dsr-appointment-attendee?limit=25&page=11" }, "next": { "example": "/dsr-appointment-attendee?limit=25&page=4" }, "prev": { "example": "/dsr-appointment-attendee?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Appointment Attendee"], "summary": "Create a new Dsr Appointment Attendee resources.", "description": "", "operationId": "createDsrAppointmentAttendee", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-appointment-attendee": { "post": { "tags": ["Dsr Appointment Attendee"], "summary": "Search for the Dsr Appointment Attendee resources.", "description": "", "operationId": "searchDsrAppointmentAttendee", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-attendee/{id}": { "get": { "tags": ["Dsr Appointment Attendee"], "summary": "Detailed information about a Dsr Appointment Attendee resource.", "description": "", "operationId": "getDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Appointment Attendee"], "summary": "Delete a Dsr Appointment Attendee resource.", "description": "", "operationId": "deleteDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Appointment Attendee"], "summary": "Partially update information about a Dsr Appointment Attendee resource.", "description": "", "operationId": "updateDsrAppointmentAttendee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Appointment Attendee resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-appointment-attendee": { "post": { "tags": ["Dsr Appointment Attendee"], "summary": "Aggregate for the Dsr Appointment Attendee resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrAppointmentAttendee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-request": { "get": { "tags": ["Dsr Appointment Request"], "summary": "List with basic information of Dsr Appointment Request resources.", "description": "", "operationId": "getDsrAppointmentRequestList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Appointment Request resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-appointment-request?limit=25" }, "last": { "example": "/dsr-appointment-request?limit=25&page=11" }, "next": { "example": "/dsr-appointment-request?limit=25&page=4" }, "prev": { "example": "/dsr-appointment-request?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Appointment Request"], "summary": "Create a new Dsr Appointment Request resources.", "description": "", "operationId": "createDsrAppointmentRequest", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-appointment-request": { "post": { "tags": ["Dsr Appointment Request"], "summary": "Search for the Dsr Appointment Request resources.", "description": "", "operationId": "searchDsrAppointmentRequest", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-request/{id}": { "get": { "tags": ["Dsr Appointment Request"], "summary": "Detailed information about a Dsr Appointment Request resource.", "description": "", "operationId": "getDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Appointment Request"], "summary": "Delete a Dsr Appointment Request resource.", "description": "", "operationId": "deleteDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Appointment Request"], "summary": "Partially update information about a Dsr Appointment Request resource.", "description": "", "operationId": "updateDsrAppointmentRequest", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Appointment Request resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-appointment-request": { "post": { "tags": ["Dsr Appointment Request"], "summary": "Aggregate for the Dsr Appointment Request resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrAppointmentRequest", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-video-chat": { "get": { "tags": ["Dsr Appointment Video Chat"], "summary": "List with basic information of Dsr Appointment Video Chat resources.", "description": "", "operationId": "getDsrAppointmentVideoChatList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Appointment Video Chat resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-appointment-video-chat?limit=25" }, "last": { "example": "/dsr-appointment-video-chat?limit=25&page=11" }, "next": { "example": "/dsr-appointment-video-chat?limit=25&page=4" }, "prev": { "example": "/dsr-appointment-video-chat?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Appointment Video Chat"], "summary": "Create a new Dsr Appointment Video Chat resources.", "description": "", "operationId": "createDsrAppointmentVideoChat", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-appointment-video-chat": { "post": { "tags": ["Dsr Appointment Video Chat"], "summary": "Search for the Dsr Appointment Video Chat resources.", "description": "", "operationId": "searchDsrAppointmentVideoChat", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-appointment-video-chat/{id}": { "get": { "tags": ["Dsr Appointment Video Chat"], "summary": "Detailed information about a Dsr Appointment Video Chat resource.", "description": "", "operationId": "getDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Appointment Video Chat"], "summary": "Delete a Dsr Appointment Video Chat resource.", "description": "", "operationId": "deleteDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Appointment Video Chat"], "summary": "Partially update information about a Dsr Appointment Video Chat resource.", "description": "", "operationId": "updateDsrAppointmentVideoChat", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_appointment_video_chat", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Appointment Video Chat resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-appointment-video-chat": { "post": { "tags": ["Dsr Appointment Video Chat"], "summary": "Aggregate for the Dsr Appointment Video Chat resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-attendee-product-collection": { "get": { "tags": ["Dsr Attendee Product Collection"], "summary": "List with basic information of Dsr Attendee Product Collection resources.", "description": "", "operationId": "getDsrAttendeeProductCollectionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Attendee Product Collection resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-attendee-product-collection?limit=25" }, "last": { "example": "/dsr-attendee-product-collection?limit=25&page=11" }, "next": { "example": "/dsr-attendee-product-collection?limit=25&page=4" }, "prev": { "example": "/dsr-attendee-product-collection?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Attendee Product Collection"], "summary": "Create a new Dsr Attendee Product Collection resources.", "description": "", "operationId": "createDsrAttendeeProductCollection", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-attendee-product-collection": { "post": { "tags": ["Dsr Attendee Product Collection"], "summary": "Search for the Dsr Attendee Product Collection resources.", "description": "", "operationId": "searchDsrAttendeeProductCollection", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-attendee-product-collection/{id}": { "get": { "tags": ["Dsr Attendee Product Collection"], "summary": "Detailed information about a Dsr Attendee Product Collection resource.", "description": "", "operationId": "getDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Attendee Product Collection"], "summary": "Delete a Dsr Attendee Product Collection resource.", "description": "", "operationId": "deleteDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Attendee Product Collection"], "summary": "Partially update information about a Dsr Attendee Product Collection resource.", "description": "", "operationId": "updateDsrAttendeeProductCollection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_attendee_product_collection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Attendee Product Collection resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-attendee-product-collection": { "post": { "tags": ["Dsr Attendee Product Collection"], "summary": "Aggregate for the Dsr Attendee Product Collection resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrAttendeeProductCollection", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-cms-slide": { "get": { "tags": ["Dsr Cms Slide"], "summary": "List with basic information of Dsr Cms Slide resources.", "description": "", "operationId": "getDsrCmsSlideList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Cms Slide resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-cms-slide?limit=25" }, "last": { "example": "/dsr-cms-slide?limit=25&page=11" }, "next": { "example": "/dsr-cms-slide?limit=25&page=4" }, "prev": { "example": "/dsr-cms-slide?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Cms Slide"], "summary": "Create a new Dsr Cms Slide resources.", "description": "", "operationId": "createDsrCmsSlide", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-cms-slide": { "post": { "tags": ["Dsr Cms Slide"], "summary": "Search for the Dsr Cms Slide resources.", "description": "", "operationId": "searchDsrCmsSlide", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-cms-slide/{id}": { "get": { "tags": ["Dsr Cms Slide"], "summary": "Detailed information about a Dsr Cms Slide resource.", "description": "", "operationId": "getDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Cms Slide"], "summary": "Delete a Dsr Cms Slide resource.", "description": "", "operationId": "deleteDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Cms Slide"], "summary": "Partially update information about a Dsr Cms Slide resource.", "description": "", "operationId": "updateDsrCmsSlide", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_cms_slide", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Cms Slide resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-cms-slide": { "post": { "tags": ["Dsr Cms Slide"], "summary": "Aggregate for the Dsr Cms Slide resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrCmsSlide", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrCmsSlide" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-interaction": { "get": { "tags": ["Dsr Interaction"], "summary": "List with basic information of Dsr Interaction resources.", "description": "", "operationId": "getDsrInteractionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Interaction resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-interaction?limit=25" }, "last": { "example": "/dsr-interaction?limit=25&page=11" }, "next": { "example": "/dsr-interaction?limit=25&page=4" }, "prev": { "example": "/dsr-interaction?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Interaction"], "summary": "Create a new Dsr Interaction resources.", "description": "", "operationId": "createDsrInteraction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-interaction": { "post": { "tags": ["Dsr Interaction"], "summary": "Search for the Dsr Interaction resources.", "description": "", "operationId": "searchDsrInteraction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrInteraction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-interaction/{id}": { "get": { "tags": ["Dsr Interaction"], "summary": "Detailed information about a Dsr Interaction resource.", "description": "", "operationId": "getDsrInteraction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Interaction"], "summary": "Delete a Dsr Interaction resource.", "description": "", "operationId": "deleteDsrInteraction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Interaction"], "summary": "Partially update information about a Dsr Interaction resource.", "description": "", "operationId": "updateDsrInteraction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Interaction resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrInteraction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-interaction": { "post": { "tags": ["Dsr Interaction"], "summary": "Aggregate for the Dsr Interaction resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrInteraction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-presentation": { "get": { "tags": ["Dsr Presentation"], "summary": "List with basic information of Dsr Presentation resources.", "description": "", "operationId": "getDsrPresentationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Presentation resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-presentation?limit=25" }, "last": { "example": "/dsr-presentation?limit=25&page=11" }, "next": { "example": "/dsr-presentation?limit=25&page=4" }, "prev": { "example": "/dsr-presentation?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Presentation"], "summary": "Create a new Dsr Presentation resources.", "description": "", "operationId": "createDsrPresentation", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-presentation": { "post": { "tags": ["Dsr Presentation"], "summary": "Search for the Dsr Presentation resources.", "description": "", "operationId": "searchDsrPresentation", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrPresentation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-presentation/{id}": { "get": { "tags": ["Dsr Presentation"], "summary": "Detailed information about a Dsr Presentation resource.", "description": "", "operationId": "getDsrPresentation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Presentation"], "summary": "Delete a Dsr Presentation resource.", "description": "", "operationId": "deleteDsrPresentation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Presentation"], "summary": "Partially update information about a Dsr Presentation resource.", "description": "", "operationId": "updateDsrPresentation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Presentation resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-presentation": { "post": { "tags": ["Dsr Presentation"], "summary": "Aggregate for the Dsr Presentation resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-presentation-cms-page": { "get": { "tags": ["Dsr Presentation Cms Page"], "summary": "List with basic information of Dsr Presentation Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "getDsrPresentationCmsPageList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Dsr Presentation Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/dsr-presentation-cms-page?limit=25" }, "last": { "example": "/dsr-presentation-cms-page?limit=25&page=11" }, "next": { "example": "/dsr-presentation-cms-page?limit=25&page=4" }, "prev": { "example": "/dsr-presentation-cms-page?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Dsr Presentation Cms Page"], "summary": "Create a new Dsr Presentation Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "createDsrPresentationCmsPage", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/dsr-presentation-cms-page": { "post": { "tags": ["Dsr Presentation Cms Page"], "summary": "Search for the Dsr Presentation Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDsrPresentationCmsPage", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dsr-presentation-cms-page/{id}": { "get": { "tags": ["Dsr Presentation Cms Page"], "summary": "Detailed information about a Dsr Presentation Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "getDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Dsr Presentation Cms Page"], "summary": "Delete a Dsr Presentation Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "deleteDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Dsr Presentation Cms Page"], "summary": "Partially update information about a Dsr Presentation Cms Page resource.", "description": "Available since: 6.0.0.0", "operationId": "updateDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Dsr Presentation Cms Page resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/dsr-presentation-cms-page": { "post": { "tags": ["Dsr Presentation Cms Page"], "summary": "Aggregate for the Dsr Presentation Cms Page resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateDsrPresentationCmsPage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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-ai-tag": { "get": { "tags": ["Media Ai Tag"], "summary": "List with basic information of Media Ai Tag resources.", "description": "", "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/media-ai-tag?limit=25" }, "last": { "example": "/media-ai-tag?limit=25&page=11" }, "next": { "example": "/media-ai-tag?limit=25&page=4" }, "prev": { "example": "/media-ai-tag?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Media Ai Tag"], "summary": "Create a new Media Ai Tag resources.", "description": "", "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/media-ai-tag": { "post": { "tags": ["Media Ai Tag"], "summary": "Search for the Media Ai Tag resources.", "description": "", "operationId": "searchMediaAiTag", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 MediaAiTag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/media-ai-tag/{id}": { "get": { "tags": ["Media Ai Tag"], "summary": "Detailed information about a Media Ai Tag resource.", "description": "", "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Media Ai Tag"], "summary": "Delete a Media Ai Tag resource.", "description": "", "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Media Ai Tag"], "summary": "Partially update information about a Media Ai Tag resource.", "description": "", "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/MediaAiTag" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/media-ai-tag": { "post": { "tags": ["Media Ai Tag"], "summary": "Aggregate for the Media Ai Tag resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateMediaAiTag", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAiTag" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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-product-warehouse": { "get": { "tags": ["Order Product Warehouse"], "summary": "List with basic information of Order Product Warehouse resources.", "description": "", "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-product-warehouse?limit=25" }, "last": { "example": "/order-product-warehouse?limit=25&page=11" }, "next": { "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { "example": "/order-product-warehouse?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Order Product Warehouse"], "summary": "Create a new Order Product Warehouse resources.", "description": "", "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-product-warehouse": { "post": { "tags": ["Order Product Warehouse"], "summary": "Search for the Order Product Warehouse resources.", "description": "", "operationId": "searchOrderProductWarehouse", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-product-warehouse/{id}": { "get": { "tags": ["Order Product Warehouse"], "summary": "Detailed information about a Order Product Warehouse resource.", "description": "", "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Order Product Warehouse"], "summary": "Delete a Order Product Warehouse resource.", "description": "", "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Order Product Warehouse"], "summary": "Partially update information about a Order Product Warehouse resource.", "description": "", "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/order-product-warehouse": { "post": { "tags": ["Order Product Warehouse"], "summary": "Aggregate for the Order Product Warehouse resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderProductWarehouse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return": { "get": { "tags": ["Order Return"], "summary": "List with basic information of Order Return resources.", "description": "", "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-return?limit=25" }, "last": { "example": "/order-return?limit=25&page=11" }, "next": { "example": "/order-return?limit=25&page=4" }, "prev": { "example": "/order-return?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Order Return"], "summary": "Create a new Order Return resources.", "description": "", "operationId": "createOrderReturn", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-return": { "post": { "tags": ["Order Return"], "summary": "Search for the Order Return resources.", "description": "", "operationId": "searchOrderReturn", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 OrderReturn", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return/{id}": { "get": { "tags": ["Order Return"], "summary": "Detailed information about a Order Return resource.", "description": "", "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Order Return"], "summary": "Delete a Order Return resource.", "description": "", "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Order Return"], "summary": "Partially update information about a Order Return resource.", "description": "", "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Return resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturn" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/order-return": { "post": { "tags": ["Order Return"], "summary": "Aggregate for the Order Return resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderReturn", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturn" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return-line-item": { "get": { "tags": ["Order Return Line Item"], "summary": "List with basic information of Order Return Line Item resources.", "description": "", "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-return-line-item?limit=25" }, "last": { "example": "/order-return-line-item?limit=25&page=11" }, "next": { "example": "/order-return-line-item?limit=25&page=4" }, "prev": { "example": "/order-return-line-item?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Order Return Line Item"], "summary": "Create a new Order Return Line Item resources.", "description": "", "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-return-line-item": { "post": { "tags": ["Order Return Line Item"], "summary": "Search for the Order Return Line Item resources.", "description": "", "operationId": "searchOrderReturnLineItem", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return-line-item/{id}": { "get": { "tags": ["Order Return Line Item"], "summary": "Detailed information about a Order Return Line Item resource.", "description": "", "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Order Return Line Item"], "summary": "Delete a Order Return Line Item resource.", "description": "", "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Order Return Line Item"], "summary": "Partially update information about a Order Return Line Item resource.", "description": "", "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/order-return-line-item": { "post": { "tags": ["Order Return Line Item"], "summary": "Aggregate for the Order Return Line Item resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderReturnLineItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return-line-item-reason": { "get": { "tags": ["Order Return Line Item Reason"], "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-return-line-item-reason?limit=25" }, "last": { "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { "example": "/order-return-line-item-reason?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Order Return Line Item Reason"], "summary": "Create a new Order Return Line Item Reason resources.", "description": "", "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-return-line-item-reason": { "post": { "tags": ["Order Return Line Item Reason"], "summary": "Search for the Order Return Line Item Reason resources.", "description": "", "operationId": "searchOrderReturnLineItemReason", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-return-line-item-reason/{id}": { "get": { "tags": ["Order Return Line Item Reason"], "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Order Return Line Item Reason"], "summary": "Delete a Order Return Line Item Reason resource.", "description": "", "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Order Return Line Item Reason"], "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/order-return-line-item-reason": { "post": { "tags": ["Order Return Line Item Reason"], "summary": "Aggregate for the Order Return Line Item Reason resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderReturnLineItemReason", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/order-warehouse-group": { "get": { "tags": ["Order Warehouse Group"], "summary": "List with basic information of Order Warehouse Group resources.", "description": "", "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/order-warehouse-group?limit=25" }, "last": { "example": "/order-warehouse-group?limit=25&page=11" }, "next": { "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { "example": "/order-warehouse-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Order Warehouse Group"], "summary": "Create a new Order Warehouse Group resources.", "description": "", "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/order-warehouse-group": { "post": { "tags": ["Order Warehouse Group"], "summary": "Search for the Order Warehouse Group resources.", "description": "", "operationId": "searchOrderWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/order-warehouse-group/{id}": { "get": { "tags": ["Order Warehouse Group"], "summary": "Detailed information about a Order Warehouse Group resource.", "description": "", "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Order Warehouse Group"], "summary": "Delete a Order Warehouse Group resource.", "description": "", "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Order Warehouse Group"], "summary": "Partially update information about a Order Warehouse Group resource.", "description": "", "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/order-warehouse-group": { "post": { "tags": ["Order Warehouse Group"], "summary": "Aggregate for the Order Warehouse Group resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateOrderWarehouseGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderWarehouseGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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-review-summary": { "get": { "tags": ["Product Review Summary"], "summary": "List with basic information of Product Review Summary resources.", "description": "", "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-review-summary?limit=25" }, "last": { "example": "/product-review-summary?limit=25&page=11" }, "next": { "example": "/product-review-summary?limit=25&page=4" }, "prev": { "example": "/product-review-summary?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Product Review Summary"], "summary": "Create a new Product Review Summary resources.", "description": "", "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-review-summary": { "post": { "tags": ["Product Review Summary"], "summary": "Search for the Product Review Summary resources.", "description": "", "operationId": "searchProductReviewSummary", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-review-summary/{id}": { "get": { "tags": ["Product Review Summary"], "summary": "Detailed information about a Product Review Summary resource.", "description": "", "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Product Review Summary"], "summary": "Delete a Product Review Summary resource.", "description": "", "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Product Review Summary"], "summary": "Partially update information about a Product Review Summary resource.", "description": "", "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Review Summary resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/product-review-summary": { "post": { "tags": ["Product Review Summary"], "summary": "Aggregate for the Product Review Summary resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductReviewSummary", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReviewSummary" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/product-warehouse": { "get": { "tags": ["Product Warehouse"], "summary": "List with basic information of Product Warehouse resources.", "description": "", "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/product-warehouse?limit=25" }, "last": { "example": "/product-warehouse?limit=25&page=11" }, "next": { "example": "/product-warehouse?limit=25&page=4" }, "prev": { "example": "/product-warehouse?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Product Warehouse"], "summary": "Create a new Product Warehouse resources.", "description": "", "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/product-warehouse": { "post": { "tags": ["Product Warehouse"], "summary": "Search for the Product Warehouse resources.", "description": "", "operationId": "searchProductWarehouse", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/product-warehouse/{id}": { "get": { "tags": ["Product Warehouse"], "summary": "Detailed information about a Product Warehouse resource.", "description": "", "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Product Warehouse"], "summary": "Delete a Product Warehouse resource.", "description": "", "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Product Warehouse"], "summary": "Partially update information about a Product Warehouse resource.", "description": "", "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Product Warehouse resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/product-warehouse": { "post": { "tags": ["Product Warehouse"], "summary": "Aggregate for the Product Warehouse resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateProductWarehouse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/quote": { "get": { "tags": ["Quote"], "summary": "List with basic information of Quote resources.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote?limit=25" }, "last": { "example": "/quote?limit=25&page=11" }, "next": { "example": "/quote?limit=25&page=4" }, "prev": { "example": "/quote?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote"], "summary": "Create a new Quote resources.", "description": "Available since: 6.5.3.0", "operationId": "createQuote", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote": { "post": { "tags": ["Quote"], "summary": "Search for the Quote resources.", "description": "Available since: 6.5.3.0", "operationId": "searchQuote", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 Quote", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote/{id}": { "get": { "tags": ["Quote"], "summary": "Detailed information about a Quote resource.", "description": "Available since: 6.5.3.0", "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote"], "summary": "Delete a Quote resource.", "description": "Available since: 6.5.3.0", "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote"], "summary": "Partially update information about a Quote resource.", "description": "Available since: 6.5.3.0", "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote": { "post": { "tags": ["Quote"], "summary": "Aggregate for the Quote resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuote", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-comment": { "get": { "tags": ["Quote Comment"], "summary": "List with basic information of Quote Comment resources.", "description": "", "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-comment?limit=25" }, "last": { "example": "/quote-comment?limit=25&page=11" }, "next": { "example": "/quote-comment?limit=25&page=4" }, "prev": { "example": "/quote-comment?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Comment"], "summary": "Create a new Quote Comment resources.", "description": "", "operationId": "createQuoteComment", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-comment": { "post": { "tags": ["Quote Comment"], "summary": "Search for the Quote Comment resources.", "description": "", "operationId": "searchQuoteComment", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteComment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-comment/{id}": { "get": { "tags": ["Quote Comment"], "summary": "Detailed information about a Quote Comment resource.", "description": "", "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Comment"], "summary": "Delete a Quote Comment resource.", "description": "", "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Comment"], "summary": "Partially update information about a Quote Comment resource.", "description": "", "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Comment resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteComment" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-comment": { "post": { "tags": ["Quote Comment"], "summary": "Aggregate for the Quote Comment resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteComment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-delivery": { "get": { "tags": ["Quote Delivery"], "summary": "List with basic information of Quote Delivery resources.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-delivery?limit=25" }, "last": { "example": "/quote-delivery?limit=25&page=11" }, "next": { "example": "/quote-delivery?limit=25&page=4" }, "prev": { "example": "/quote-delivery?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Delivery"], "summary": "Create a new Quote Delivery resources.", "description": "Available since: 6.5.3.0", "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-delivery": { "post": { "tags": ["Quote Delivery"], "summary": "Search for the Quote Delivery resources.", "description": "Available since: 6.5.3.0", "operationId": "searchQuoteDelivery", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-delivery/{id}": { "get": { "tags": ["Quote Delivery"], "summary": "Detailed information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Delivery"], "summary": "Delete a Quote Delivery resource.", "description": "Available since: 6.5.3.0", "operationId": "deleteQuoteDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Delivery"], "summary": "Partially update information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", "operationId": "updateQuoteDelivery", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Delivery resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-delivery": { "post": { "tags": ["Quote Delivery"], "summary": "Aggregate for the Quote Delivery resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteDelivery", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-delivery-position": { "get": { "tags": ["Quote Delivery Position"], "summary": "List with basic information of Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-delivery-position?limit=25" }, "last": { "example": "/quote-delivery-position?limit=25&page=11" }, "next": { "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { "example": "/quote-delivery-position?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Delivery Position"], "summary": "Create a new Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-delivery-position": { "post": { "tags": ["Quote Delivery Position"], "summary": "Search for the Quote Delivery Position resources.", "description": "Available since: 6.5.3.0", "operationId": "searchQuoteDeliveryPosition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-delivery-position/{id}": { "get": { "tags": ["Quote Delivery Position"], "summary": "Detailed information about a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Delivery Position"], "summary": "Delete a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", "operationId": "deleteQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Delivery Position"], "summary": "Partially update information about a Quote Delivery Position resource.", "description": "Available since: 6.5.3.0", "operationId": "updateQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-delivery-position": { "post": { "tags": ["Quote Delivery Position"], "summary": "Aggregate for the Quote Delivery Position resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteDeliveryPosition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-document": { "get": { "tags": ["Quote Document"], "summary": "List with basic information of Quote Document resources.", "description": "", "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-document?limit=25" }, "last": { "example": "/quote-document?limit=25&page=11" }, "next": { "example": "/quote-document?limit=25&page=4" }, "prev": { "example": "/quote-document?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Document"], "summary": "Create a new Quote Document resources.", "description": "", "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-document": { "post": { "tags": ["Quote Document"], "summary": "Search for the Quote Document resources.", "description": "", "operationId": "searchQuoteDocument", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteDocument", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-document/{id}": { "get": { "tags": ["Quote Document"], "summary": "Detailed information about a Quote Document resource.", "description": "", "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Document"], "summary": "Delete a Quote Document resource.", "description": "", "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Document"], "summary": "Partially update information about a Quote Document resource.", "description": "", "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Document resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteDocument" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-document": { "post": { "tags": ["Quote Document"], "summary": "Aggregate for the Quote Document resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteDocument", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-employee": { "get": { "tags": ["Quote Employee"], "summary": "List with basic information of Quote Employee resources.", "description": "", "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-employee?limit=25" }, "last": { "example": "/quote-employee?limit=25&page=11" }, "next": { "example": "/quote-employee?limit=25&page=4" }, "prev": { "example": "/quote-employee?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Employee"], "summary": "Create a new Quote Employee resources.", "description": "", "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-employee": { "post": { "tags": ["Quote Employee"], "summary": "Search for the Quote Employee resources.", "description": "", "operationId": "searchQuoteEmployee", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-employee/{id}": { "get": { "tags": ["Quote Employee"], "summary": "Detailed information about a Quote Employee resource.", "description": "", "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Employee"], "summary": "Delete a Quote Employee resource.", "description": "", "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Employee"], "summary": "Partially update information about a Quote Employee resource.", "description": "", "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Employee resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-employee": { "post": { "tags": ["Quote Employee"], "summary": "Aggregate for the Quote Employee resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteEmployee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-line-item": { "get": { "tags": ["Quote Line Item"], "summary": "List with basic information of Quote Line Item resources.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-line-item?limit=25" }, "last": { "example": "/quote-line-item?limit=25&page=11" }, "next": { "example": "/quote-line-item?limit=25&page=4" }, "prev": { "example": "/quote-line-item?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Line Item"], "summary": "Create a new Quote Line Item resources.", "description": "Available since: 6.5.3.0", "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-line-item": { "post": { "tags": ["Quote Line Item"], "summary": "Search for the Quote Line Item resources.", "description": "Available since: 6.5.3.0", "operationId": "searchQuoteLineItem", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-line-item/{id}": { "get": { "tags": ["Quote Line Item"], "summary": "Detailed information about a Quote Line Item resource.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Line Item"], "summary": "Delete a Quote Line Item resource.", "description": "Available since: 6.5.3.0", "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Line Item"], "summary": "Partially update information about a Quote Line Item resource.", "description": "Available since: 6.5.3.0", "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Line Item resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-line-item": { "post": { "tags": ["Quote Line Item"], "summary": "Aggregate for the Quote Line Item resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteLineItem", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-transaction": { "get": { "tags": ["Quote Transaction"], "summary": "List with basic information of Quote Transaction resources.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/quote-transaction?limit=25" }, "last": { "example": "/quote-transaction?limit=25&page=11" }, "next": { "example": "/quote-transaction?limit=25&page=4" }, "prev": { "example": "/quote-transaction?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Quote Transaction"], "summary": "Create a new Quote Transaction resources.", "description": "Available since: 6.5.3.0", "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/quote-transaction": { "post": { "tags": ["Quote Transaction"], "summary": "Search for the Quote Transaction resources.", "description": "Available since: 6.5.3.0", "operationId": "searchQuoteTransaction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/quote-transaction/{id}": { "get": { "tags": ["Quote Transaction"], "summary": "Detailed information about a Quote Transaction resource.", "description": "Available since: 6.5.3.0", "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Quote Transaction"], "summary": "Delete a Quote Transaction resource.", "description": "Available since: 6.5.3.0", "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Quote Transaction"], "summary": "Partially update information about a Quote Transaction resource.", "description": "Available since: 6.5.3.0", "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Quote Transaction resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/quote-transaction": { "post": { "tags": ["Quote Transaction"], "summary": "Aggregate for the Quote Transaction resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateQuoteTransaction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/saas-app-storefront-config": { "get": { "tags": ["Saas App Storefront Config"], "summary": "List with basic information of Saas App Storefront Config resources.", "description": "", "operationId": "getSaasAppStorefrontConfigList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Saas App Storefront 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/SaasAppStorefrontConfig" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/saas-app-storefront-config?limit=25" }, "last": { "example": "/saas-app-storefront-config?limit=25&page=11" }, "next": { "example": "/saas-app-storefront-config?limit=25&page=4" }, "prev": { "example": "/saas-app-storefront-config?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Saas App Storefront Config"], "summary": "Create a new Saas App Storefront Config resources.", "description": "", "operationId": "createSaasAppStorefrontConfig", "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/SaasAppStorefrontConfig" } } } }, "responses": { "200": { "description": "Detail of SaasAppStorefrontConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/saas-app-storefront-config": { "post": { "tags": ["Saas App Storefront Config"], "summary": "Search for the Saas App Storefront Config resources.", "description": "", "operationId": "searchSaasAppStorefrontConfig", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SaasAppStorefrontConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/saas-app-storefront-config/{id}": { "get": { "tags": ["Saas App Storefront Config"], "summary": "Detailed information about a Saas App Storefront Config resource.", "description": "", "operationId": "getSaasAppStorefrontConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_app_storefront_config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SaasAppStorefrontConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Saas App Storefront Config"], "summary": "Delete a Saas App Storefront Config resource.", "description": "", "operationId": "deleteSaasAppStorefrontConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_app_storefront_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Saas App Storefront Config"], "summary": "Partially update information about a Saas App Storefront Config resource.", "description": "", "operationId": "updateSaasAppStorefrontConfig", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_app_storefront_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 Saas App Storefront Config resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } }, "responses": { "200": { "description": "Detail of SaasAppStorefrontConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/saas-app-storefront-config": { "post": { "tags": ["Saas App Storefront Config"], "summary": "Aggregate for the Saas App Storefront Config resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSaasAppStorefrontConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SaasAppStorefrontConfig", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasAppStorefrontConfig" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/saas-storefront-demo-token": { "get": { "tags": ["Saas Storefront Demo Token"], "summary": "List with basic information of Saas Storefront Demo Token resources.", "description": "", "operationId": "getSaasStorefrontDemoTokenList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Saas Storefront Demo Token resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/saas-storefront-demo-token?limit=25" }, "last": { "example": "/saas-storefront-demo-token?limit=25&page=11" }, "next": { "example": "/saas-storefront-demo-token?limit=25&page=4" }, "prev": { "example": "/saas-storefront-demo-token?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Saas Storefront Demo Token"], "summary": "Create a new Saas Storefront Demo Token resources.", "description": "", "operationId": "createSaasStorefrontDemoToken", "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/SaasStorefrontDemoToken" } } } }, "responses": { "200": { "description": "Detail of SaasStorefrontDemoToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/saas-storefront-demo-token": { "post": { "tags": ["Saas Storefront Demo Token"], "summary": "Search for the Saas Storefront Demo Token resources.", "description": "", "operationId": "searchSaasStorefrontDemoToken", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SaasStorefrontDemoToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/saas-storefront-demo-token/{id}": { "get": { "tags": ["Saas Storefront Demo Token"], "summary": "Detailed information about a Saas Storefront Demo Token resource.", "description": "", "operationId": "getSaasStorefrontDemoToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_storefront_demo_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SaasStorefrontDemoToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Saas Storefront Demo Token"], "summary": "Delete a Saas Storefront Demo Token resource.", "description": "", "operationId": "deleteSaasStorefrontDemoToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_storefront_demo_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Saas Storefront Demo Token"], "summary": "Partially update information about a Saas Storefront Demo Token resource.", "description": "", "operationId": "updateSaasStorefrontDemoToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the saas_storefront_demo_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Saas Storefront Demo Token resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } }, "responses": { "200": { "description": "Detail of SaasStorefrontDemoToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/saas-storefront-demo-token": { "post": { "tags": ["Saas Storefront Demo Token"], "summary": "Aggregate for the Saas Storefront Demo Token resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSaasStorefrontDemoToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SaasStorefrontDemoToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SaasStorefrontDemoToken" } } } } } } }, "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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/sales-channel-domain": { "post": { "tags": ["Sales Channel Domain"], "summary": "Aggregate for the Sales Channel Domain resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSalesChannelDomain", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sales-channel-type": { "get": { "tags": ["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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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": "Create a new Salutation resources.", "description": "Available since: 6.0.0.0", "operationId": "createSalutation", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/spatial-render-config-size": { "get": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "List with basic information of Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-render-config-size?limit=25" }, "last": { "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { "example": "/spatial-render-config-size?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Create a new Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-render-config-size": { "post": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Search for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialRenderConfigSize", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-render-config-size/{id}": { "get": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Detailed information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Delete a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Partially update information about a Spatial Render Config Size resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-render-config-size": { "post": { "tags": ["Spatial Render Config Size", "Experimental"], "summary": "Aggregate for the Spatial Render Config Size resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialRenderConfigSize", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene": { "get": { "tags": ["Spatial Scene", "Experimental"], "summary": "List with basic information of Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene?limit=25" }, "last": { "example": "/spatial-scene?limit=25&page=11" }, "next": { "example": "/spatial-scene?limit=25&page=4" }, "prev": { "example": "/spatial-scene?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene", "Experimental"], "summary": "Create a new Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialScene", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene": { "post": { "tags": ["Spatial Scene", "Experimental"], "summary": "Search for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialScene", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SpatialScene", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene/{id}": { "get": { "tags": ["Spatial Scene", "Experimental"], "summary": "Detailed information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene", "Experimental"], "summary": "Delete a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene", "Experimental"], "summary": "Partially update information about a Spatial Scene resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScene" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene": { "post": { "tags": ["Spatial Scene", "Experimental"], "summary": "Aggregate for the Spatial Scene resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialScene", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScene" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-camera": { "get": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "List with basic information of Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-camera?limit=25" }, "last": { "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { "example": "/spatial-scene-camera?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Create a new Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-camera": { "post": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Search for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialSceneCamera", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-camera/{id}": { "get": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Detailed information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Delete a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Partially update information about a Spatial Scene Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-camera": { "post": { "tags": ["Spatial Scene Camera", "Experimental"], "summary": "Aggregate for the Spatial Scene Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-group": { "get": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "List with basic information of Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-group?limit=25" }, "last": { "example": "/spatial-scene-group?limit=25&page=11" }, "next": { "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { "example": "/spatial-scene-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Create a new Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialSceneGroup", "parameters": [ { "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/SpatialSceneGroup" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-group": { "post": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Search for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialSceneGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-group/{id}": { "get": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Detailed information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Delete a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Partially update information about a Spatial Scene Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_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 Spatial Scene Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-group": { "post": { "tags": ["Spatial Scene Group", "Experimental"], "summary": "Aggregate for the Spatial Scene Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-light": { "get": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "List with basic information of Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-light?limit=25" }, "last": { "example": "/spatial-scene-light?limit=25&page=11" }, "next": { "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { "example": "/spatial-scene-light?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Create a new Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-light": { "post": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Search for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialSceneLight", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-light/{id}": { "get": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Detailed information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Delete a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Partially update information about a Spatial Scene Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-light": { "post": { "tags": ["Spatial Scene Light", "Experimental"], "summary": "Aggregate for the Spatial Scene Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-material": { "get": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "List with basic information of Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-material?limit=25" }, "last": { "example": "/spatial-scene-material?limit=25&page=11" }, "next": { "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { "example": "/spatial-scene-material?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Create a new Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-material": { "post": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Search for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialSceneMaterial", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-material/{id}": { "get": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Detailed information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Delete a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Partially update information about a Spatial Scene Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-material": { "post": { "tags": ["Spatial Scene Material", "Experimental"], "summary": "Aggregate for the Spatial Scene Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-object": { "get": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "List with basic information of Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-object?limit=25" }, "last": { "example": "/spatial-scene-object?limit=25&page=11" }, "next": { "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { "example": "/spatial-scene-object?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Create a new Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-object": { "post": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Search for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialSceneObject", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-object/{id}": { "get": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Detailed information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Delete a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Partially update information about a Spatial Scene Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-object": { "post": { "tags": ["Spatial Scene Object", "Experimental"], "summary": "Aggregate for the Spatial Scene Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-primitive": { "get": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "List with basic information of Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/spatial-scene-primitive?limit=25" }, "last": { "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { "example": "/spatial-scene-primitive?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Create a new Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/spatial-scene-primitive": { "post": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Search for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSpatialScenePrimitive", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/spatial-scene-primitive/{id}": { "get": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Detailed information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Delete a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Partially update information about a Spatial Scene Primitive resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/spatial-scene-primitive": { "post": { "tags": ["Spatial Scene Primitive", "Experimental"], "summary": "Aggregate for the Spatial Scene Primitive resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sso-provider": { "get": { "tags": ["Sso Provider", "Experimental"], "summary": "List with basic information of Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sso-provider?limit=25" }, "last": { "example": "/sso-provider?limit=25&page=11" }, "next": { "example": "/sso-provider?limit=25&page=4" }, "prev": { "example": "/sso-provider?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Sso Provider", "Experimental"], "summary": "Create a new Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSsoProvider", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sso-provider": { "post": { "tags": ["Sso Provider", "Experimental"], "summary": "Search for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSsoProvider", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sso-provider/{id}": { "get": { "tags": ["Sso Provider", "Experimental"], "summary": "Detailed information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Sso Provider", "Experimental"], "summary": "Delete a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Sso Provider", "Experimental"], "summary": "Partially update information about a Sso Provider resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProvider" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/sso-provider": { "post": { "tags": ["Sso Provider", "Experimental"], "summary": "Aggregate for the Sso Provider resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSsoProvider", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProvider" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sso-provider-customer": { "get": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "List with basic information of Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/sso-provider-customer?limit=25" }, "last": { "example": "/sso-provider-customer?limit=25&page=11" }, "next": { "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { "example": "/sso-provider-customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Create a new Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/sso-provider-customer": { "post": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Search for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "searchSsoProviderCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/sso-provider-customer/{id}": { "get": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Detailed information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Delete a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Partially update information about a Sso Provider Customer resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/sso-provider-customer": { "post": { "tags": ["Sso Provider Customer", "Experimental"], "summary": "Aggregate for the Sso Provider Customer resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/subscription": { "get": { "tags": ["Subscription"], "summary": "List with basic information of Subscription resources.", "description": "", "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/subscription?limit=25" }, "last": { "example": "/subscription?limit=25&page=11" }, "next": { "example": "/subscription?limit=25&page=4" }, "prev": { "example": "/subscription?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Subscription"], "summary": "Create a new Subscription resources.", "description": "", "operationId": "createSubscription", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/subscription": { "post": { "tags": ["Subscription"], "summary": "Search for the Subscription resources.", "description": "", "operationId": "searchSubscription", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription/{id}": { "get": { "tags": ["Subscription"], "summary": "Detailed information about a Subscription resource.", "description": "", "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Subscription"], "summary": "Delete a Subscription resource.", "description": "", "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Subscription"], "summary": "Partially update information about a Subscription resource.", "description": "", "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Subscription resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Subscription" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/subscription": { "post": { "tags": ["Subscription"], "summary": "Aggregate for the Subscription resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-address": { "get": { "tags": ["Subscription Address"], "summary": "List with basic information of Subscription Address resources.", "description": "", "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/subscription-address?limit=25" }, "last": { "example": "/subscription-address?limit=25&page=11" }, "next": { "example": "/subscription-address?limit=25&page=4" }, "prev": { "example": "/subscription-address?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Subscription Address"], "summary": "Create a new Subscription Address resources.", "description": "", "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/subscription-address": { "post": { "tags": ["Subscription Address"], "summary": "Search for the Subscription Address resources.", "description": "", "operationId": "searchSubscriptionAddress", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-address/{id}": { "get": { "tags": ["Subscription Address"], "summary": "Detailed information about a Subscription Address resource.", "description": "", "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Subscription Address"], "summary": "Delete a Subscription Address resource.", "description": "", "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Subscription Address"], "summary": "Partially update information about a Subscription Address resource.", "description": "", "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Subscription Address resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/subscription-address": { "post": { "tags": ["Subscription Address"], "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-customer": { "get": { "tags": ["Subscription Customer"], "summary": "List with basic information of Subscription Customer resources.", "description": "", "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/subscription-customer?limit=25" }, "last": { "example": "/subscription-customer?limit=25&page=11" }, "next": { "example": "/subscription-customer?limit=25&page=4" }, "prev": { "example": "/subscription-customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Subscription Customer"], "summary": "Create a new Subscription Customer resources.", "description": "", "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/subscription-customer": { "post": { "tags": ["Subscription Customer"], "summary": "Search for the Subscription Customer resources.", "description": "", "operationId": "searchSubscriptionCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-customer/{id}": { "get": { "tags": ["Subscription Customer"], "summary": "Detailed information about a Subscription Customer resource.", "description": "", "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Subscription Customer"], "summary": "Delete a Subscription Customer resource.", "description": "", "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Subscription Customer"], "summary": "Partially update information about a Subscription Customer resource.", "description": "", "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Subscription Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/subscription-customer": { "post": { "tags": ["Subscription Customer"], "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-interval": { "get": { "tags": ["Subscription Interval"], "summary": "List with basic information of Subscription Interval resources.", "description": "", "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/subscription-interval?limit=25" }, "last": { "example": "/subscription-interval?limit=25&page=11" }, "next": { "example": "/subscription-interval?limit=25&page=4" }, "prev": { "example": "/subscription-interval?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Subscription Interval"], "summary": "Create a new Subscription Interval resources.", "description": "", "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/subscription-interval": { "post": { "tags": ["Subscription Interval"], "summary": "Search for the Subscription Interval resources.", "description": "", "operationId": "searchSubscriptionInterval", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-interval/{id}": { "get": { "tags": ["Subscription Interval"], "summary": "Detailed information about a Subscription Interval resource.", "description": "", "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Subscription Interval"], "summary": "Delete a Subscription Interval resource.", "description": "", "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Subscription Interval"], "summary": "Partially update information about a Subscription Interval resource.", "description": "", "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Subscription Interval resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/subscription-interval": { "post": { "tags": ["Subscription Interval"], "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-plan": { "get": { "tags": ["Subscription Plan"], "summary": "List with basic information of Subscription Plan resources.", "description": "", "operationId": "getSubscriptionPlanList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/subscription-plan?limit=25" }, "last": { "example": "/subscription-plan?limit=25&page=11" }, "next": { "example": "/subscription-plan?limit=25&page=4" }, "prev": { "example": "/subscription-plan?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Subscription Plan"], "summary": "Create a new Subscription Plan resources.", "description": "", "operationId": "createSubscriptionPlan", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/subscription-plan": { "post": { "tags": ["Subscription Plan"], "summary": "Search for the Subscription Plan resources.", "description": "", "operationId": "searchSubscriptionPlan", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/subscription-plan/{id}": { "get": { "tags": ["Subscription Plan"], "summary": "Detailed information about a Subscription Plan resource.", "description": "", "operationId": "getSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Subscription Plan"], "summary": "Delete a Subscription Plan resource.", "description": "", "operationId": "deleteSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Subscription Plan"], "summary": "Partially update information about a Subscription Plan resource.", "description": "", "operationId": "updateSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Subscription Plan resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/subscription-plan": { "post": { "tags": ["Subscription Plan"], "summary": "Aggregate for the Subscription Plan resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-block-rule": { "get": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "List with basic information of Swag Cms Extensions Block Rule resources.", "description": "", "operationId": "getSwagCmsExtensionsBlockRuleList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Block 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/SwagCmsExtensionsBlockRule" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-block-rule?limit=25" }, "last": { "example": "/swag-cms-extensions-block-rule?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-block-rule?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-block-rule?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Create a new Swag Cms Extensions Block Rule resources.", "description": "", "operationId": "createSwagCmsExtensionsBlockRule", "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/SwagCmsExtensionsBlockRule" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsBlockRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-block-rule": { "post": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Search for the Swag Cms Extensions Block Rule resources.", "description": "", "operationId": "searchSwagCmsExtensionsBlockRule", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsBlockRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-block-rule/{id}": { "get": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Detailed information about a Swag Cms Extensions Block Rule resource.", "description": "", "operationId": "getSwagCmsExtensionsBlockRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_block_rule", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsBlockRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Delete a Swag Cms Extensions Block Rule resource.", "description": "", "operationId": "deleteSwagCmsExtensionsBlockRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_block_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Partially update information about a Swag Cms Extensions Block Rule resource.", "description": "", "operationId": "updateSwagCmsExtensionsBlockRule", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_block_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 Swag Cms Extensions Block Rule resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsBlockRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-block-rule": { "post": { "tags": ["Swag Cms Extensions Block Rule"], "summary": "Aggregate for the Swag Cms Extensions Block Rule resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsBlockRule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsBlockRule", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsBlockRule" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form": { "get": { "tags": ["Swag Cms Extensions Form"], "summary": "List with basic information of Swag Cms Extensions Form resources.", "description": "", "operationId": "getSwagCmsExtensionsFormList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Form resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-form?limit=25" }, "last": { "example": "/swag-cms-extensions-form?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-form?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-form?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Form"], "summary": "Create a new Swag Cms Extensions Form resources.", "description": "", "operationId": "createSwagCmsExtensionsForm", "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/SwagCmsExtensionsForm" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsForm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-form": { "post": { "tags": ["Swag Cms Extensions Form"], "summary": "Search for the Swag Cms Extensions Form resources.", "description": "", "operationId": "searchSwagCmsExtensionsForm", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsForm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form/{id}": { "get": { "tags": ["Swag Cms Extensions Form"], "summary": "Detailed information about a Swag Cms Extensions Form resource.", "description": "", "operationId": "getSwagCmsExtensionsForm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsForm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Form"], "summary": "Delete a Swag Cms Extensions Form resource.", "description": "", "operationId": "deleteSwagCmsExtensionsForm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Form"], "summary": "Partially update information about a Swag Cms Extensions Form resource.", "description": "", "operationId": "updateSwagCmsExtensionsForm", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Cms Extensions Form resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsForm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-form": { "post": { "tags": ["Swag Cms Extensions Form"], "summary": "Aggregate for the Swag Cms Extensions Form resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsForm", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsForm", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form-group": { "get": { "tags": ["Swag Cms Extensions Form Group"], "summary": "List with basic information of Swag Cms Extensions Form Group resources.", "description": "", "operationId": "getSwagCmsExtensionsFormGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Form 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/SwagCmsExtensionsFormGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-form-group?limit=25" }, "last": { "example": "/swag-cms-extensions-form-group?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-form-group?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-form-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Create a new Swag Cms Extensions Form Group resources.", "description": "", "operationId": "createSwagCmsExtensionsFormGroup", "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/SwagCmsExtensionsFormGroup" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-form-group": { "post": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Search for the Swag Cms Extensions Form Group resources.", "description": "", "operationId": "searchSwagCmsExtensionsFormGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsFormGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form-group/{id}": { "get": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Detailed information about a Swag Cms Extensions Form Group resource.", "description": "", "operationId": "getSwagCmsExtensionsFormGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Delete a Swag Cms Extensions Form Group resource.", "description": "", "operationId": "deleteSwagCmsExtensionsFormGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Partially update information about a Swag Cms Extensions Form Group resource.", "description": "", "operationId": "updateSwagCmsExtensionsFormGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_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 Swag Cms Extensions Form Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-form-group": { "post": { "tags": ["Swag Cms Extensions Form Group"], "summary": "Aggregate for the Swag Cms Extensions Form Group resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsFormGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsFormGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form-group-field": { "get": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "List with basic information of Swag Cms Extensions Form Group Field resources.", "description": "", "operationId": "getSwagCmsExtensionsFormGroupFieldList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Form Group 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/SwagCmsExtensionsFormGroupField" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-form-group-field?limit=25" }, "last": { "example": "/swag-cms-extensions-form-group-field?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-form-group-field?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-form-group-field?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Create a new Swag Cms Extensions Form Group Field resources.", "description": "", "operationId": "createSwagCmsExtensionsFormGroupField", "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/SwagCmsExtensionsFormGroupField" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroupField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-form-group-field": { "post": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Search for the Swag Cms Extensions Form Group Field resources.", "description": "", "operationId": "searchSwagCmsExtensionsFormGroupField", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsFormGroupField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-form-group-field/{id}": { "get": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Detailed information about a Swag Cms Extensions Form Group Field resource.", "description": "", "operationId": "getSwagCmsExtensionsFormGroupField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_group_field", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroupField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Delete a Swag Cms Extensions Form Group Field resource.", "description": "", "operationId": "deleteSwagCmsExtensionsFormGroupField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_group_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Partially update information about a Swag Cms Extensions Form Group Field resource.", "description": "", "operationId": "updateSwagCmsExtensionsFormGroupField", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_form_group_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 Swag Cms Extensions Form Group Field resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsFormGroupField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-form-group-field": { "post": { "tags": ["Swag Cms Extensions Form Group Field"], "summary": "Aggregate for the Swag Cms Extensions Form Group Field resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsFormGroupField", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsFormGroupField", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-quickview": { "get": { "tags": ["Swag Cms Extensions Quickview"], "summary": "List with basic information of Swag Cms Extensions Quickview resources.", "description": "", "operationId": "getSwagCmsExtensionsQuickviewList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Quickview resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-quickview?limit=25" }, "last": { "example": "/swag-cms-extensions-quickview?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-quickview?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-quickview?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Create a new Swag Cms Extensions Quickview resources.", "description": "", "operationId": "createSwagCmsExtensionsQuickview", "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/SwagCmsExtensionsQuickview" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsQuickview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-quickview": { "post": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Search for the Swag Cms Extensions Quickview resources.", "description": "", "operationId": "searchSwagCmsExtensionsQuickview", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsQuickview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-quickview/{id}": { "get": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Detailed information about a Swag Cms Extensions Quickview resource.", "description": "", "operationId": "getSwagCmsExtensionsQuickview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_quickview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsQuickview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Delete a Swag Cms Extensions Quickview resource.", "description": "", "operationId": "deleteSwagCmsExtensionsQuickview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_quickview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Partially update information about a Swag Cms Extensions Quickview resource.", "description": "", "operationId": "updateSwagCmsExtensionsQuickview", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_quickview", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Cms Extensions Quickview resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsQuickview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-quickview": { "post": { "tags": ["Swag Cms Extensions Quickview"], "summary": "Aggregate for the Swag Cms Extensions Quickview resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsQuickview", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsQuickview", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsQuickview" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-scroll-navigation": { "get": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "List with basic information of Swag Cms Extensions Scroll Navigation resources.", "description": "", "operationId": "getSwagCmsExtensionsScrollNavigationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Scroll Navigation resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-scroll-navigation?limit=25" }, "last": { "example": "/swag-cms-extensions-scroll-navigation?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-scroll-navigation?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-scroll-navigation?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Create a new Swag Cms Extensions Scroll Navigation resources.", "description": "", "operationId": "createSwagCmsExtensionsScrollNavigation", "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/SwagCmsExtensionsScrollNavigation" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-scroll-navigation": { "post": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Search for the Swag Cms Extensions Scroll Navigation resources.", "description": "", "operationId": "searchSwagCmsExtensionsScrollNavigation", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsScrollNavigation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-scroll-navigation/{id}": { "get": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Detailed information about a Swag Cms Extensions Scroll Navigation resource.", "description": "", "operationId": "getSwagCmsExtensionsScrollNavigation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Delete a Swag Cms Extensions Scroll Navigation resource.", "description": "", "operationId": "deleteSwagCmsExtensionsScrollNavigation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Partially update information about a Swag Cms Extensions Scroll Navigation resource.", "description": "", "operationId": "updateSwagCmsExtensionsScrollNavigation", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Cms Extensions Scroll Navigation resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-scroll-navigation": { "post": { "tags": ["Swag Cms Extensions Scroll Navigation"], "summary": "Aggregate for the Swag Cms Extensions Scroll Navigation resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsScrollNavigation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsScrollNavigation", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigation" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-scroll-navigation-page-settings": { "get": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "List with basic information of Swag Cms Extensions Scroll Navigation Page Settings resources.", "description": "", "operationId": "getSwagCmsExtensionsScrollNavigationPageSettingsList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Cms Extensions Scroll Navigation Page Settings resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-cms-extensions-scroll-navigation-page-settings?limit=25" }, "last": { "example": "/swag-cms-extensions-scroll-navigation-page-settings?limit=25&page=11" }, "next": { "example": "/swag-cms-extensions-scroll-navigation-page-settings?limit=25&page=4" }, "prev": { "example": "/swag-cms-extensions-scroll-navigation-page-settings?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Create a new Swag Cms Extensions Scroll Navigation Page Settings resources.", "description": "", "operationId": "createSwagCmsExtensionsScrollNavigationPageSettings", "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/SwagCmsExtensionsScrollNavigationPageSettings" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigationPageSettings", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-cms-extensions-scroll-navigation-page-settings": { "post": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Search for the Swag Cms Extensions Scroll Navigation Page Settings resources.", "description": "", "operationId": "searchSwagCmsExtensionsScrollNavigationPageSettings", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCmsExtensionsScrollNavigationPageSettings", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-cms-extensions-scroll-navigation-page-settings/{id}": { "get": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Detailed information about a Swag Cms Extensions Scroll Navigation Page Settings resource.", "description": "", "operationId": "getSwagCmsExtensionsScrollNavigationPageSettings", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation_page_settings", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigationPageSettings", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Delete a Swag Cms Extensions Scroll Navigation Page Settings resource.", "description": "", "operationId": "deleteSwagCmsExtensionsScrollNavigationPageSettings", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation_page_settings", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Partially update information about a Swag Cms Extensions Scroll Navigation Page Settings resource.", "description": "", "operationId": "updateSwagCmsExtensionsScrollNavigationPageSettings", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_cms_extensions_scroll_navigation_page_settings", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Cms Extensions Scroll Navigation Page Settings resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } }, "responses": { "200": { "description": "Detail of SwagCmsExtensionsScrollNavigationPageSettings", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-cms-extensions-scroll-navigation-page-settings": { "post": { "tags": ["Swag Cms Extensions Scroll Navigation Page Settings"], "summary": "Aggregate for the Swag Cms Extensions Scroll Navigation Page Settings resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCmsExtensionsScrollNavigationPageSettings", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCmsExtensionsScrollNavigationPageSettings", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsScrollNavigationPageSettings" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template": { "get": { "tags": ["Swag Customized Products Template"], "summary": "List with basic information of Swag Customized Products Template resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template?limit=25" }, "last": { "example": "/swag-customized-products-template?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template"], "summary": "Create a new Swag Customized Products Template resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplate", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template": { "post": { "tags": ["Swag Customized Products Template"], "summary": "Search for the Swag Customized Products Template resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplate", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template/{id}": { "get": { "tags": ["Swag Customized Products Template"], "summary": "Detailed information about a Swag Customized Products Template resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template"], "summary": "Delete a Swag Customized Products Template resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template"], "summary": "Partially update information about a Swag Customized Products Template resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template": { "post": { "tags": ["Swag Customized Products Template"], "summary": "Aggregate for the Swag Customized Products Template resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-configuration": { "get": { "tags": ["Swag Customized Products Template Configuration"], "summary": "List with basic information of Swag Customized Products Template Configuration resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateConfigurationList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Configuration resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-configuration?limit=25" }, "last": { "example": "/swag-customized-products-template-configuration?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-configuration?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-configuration?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Create a new Swag Customized Products Template Configuration resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-configuration": { "post": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Search for the Swag Customized Products Template Configuration resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-configuration/{id}": { "get": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Delete a Swag Customized Products Template Configuration resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-configuration": { "post": { "tags": ["Swag Customized Products Template Configuration"], "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-configuration-share": { "get": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Configuration Share resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-configuration-share?limit=25" }, "last": { "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Create a new Swag Customized Products Template Configuration Share resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-configuration-share": { "post": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-configuration-share/{id}": { "get": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Delete a Swag Customized Products Template Configuration Share resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-configuration-share": { "post": { "tags": ["Swag Customized Products Template Configuration Share"], "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion": { "get": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Exclusion resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-exclusion?limit=25" }, "last": { "example": "/swag-customized-products-template-exclusion?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-exclusion?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-exclusion?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Create a new Swag Customized Products Template Exclusion resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-exclusion": { "post": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion/{id}": { "get": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Delete a Swag Customized Products Template Exclusion resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-exclusion": { "post": { "tags": ["Swag Customized Products Template Exclusion"], "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion-condition": { "get": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Exclusion Condition resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-exclusion-condition?limit=25" }, "last": { "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-exclusion-condition": { "post": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion-condition/{id}": { "get": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-exclusion-condition": { "post": { "tags": ["Swag Customized Products Template Exclusion Condition"], "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion-operator": { "get": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Exclusion Operator resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-exclusion-operator?limit=25" }, "last": { "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "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/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-exclusion-operator/{id}": { "get": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-exclusion-operator": { "post": { "tags": ["Swag Customized Products Template Exclusion Operator"], "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option": { "get": { "tags": ["Swag Customized Products Template Option"], "summary": "List with basic information of Swag Customized Products Template Option resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Option resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-option?limit=25" }, "last": { "example": "/swag-customized-products-template-option?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-option?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-option?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Option"], "summary": "Create a new Swag Customized Products Template Option resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateOption", "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/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-option": { "post": { "tags": ["Swag Customized Products Template Option"], "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option/{id}": { "get": { "tags": ["Swag Customized Products Template Option"], "summary": "Detailed information about a Swag Customized Products Template Option resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Option"], "summary": "Delete a Swag Customized Products Template Option resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Option"], "summary": "Partially update information about a Swag Customized Products Template Option resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-option": { "post": { "tags": ["Swag Customized Products Template Option"], "summary": "Aggregate for the Swag Customized Products Template Option resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-price": { "get": { "tags": ["Swag Customized Products Template Option Price"], "summary": "List with basic information of Swag Customized Products Template Option Price resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Option Price resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-option-price?limit=25" }, "last": { "example": "/swag-customized-products-template-option-price?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-option-price?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-option-price?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Create a new Swag Customized Products Template Option Price resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-option-price": { "post": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-price/{id}": { "get": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Delete a Swag Customized Products Template Option Price resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-option-price": { "post": { "tags": ["Swag Customized Products Template Option Price"], "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-value": { "get": { "tags": ["Swag Customized Products Template Option Value"], "summary": "List with basic information of Swag Customized Products Template Option Value resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionValueList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Option Value resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-option-value?limit=25" }, "last": { "example": "/swag-customized-products-template-option-value?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-option-value?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-option-value?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Create a new Swag Customized Products Template Option Value resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-option-value": { "post": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-value/{id}": { "get": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Delete a Swag Customized Products Template Option Value resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-option-value": { "post": { "tags": ["Swag Customized Products Template Option Value"], "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-value-price": { "get": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Customized Products Template Option Value Price resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-customized-products-template-option-value-price?limit=25" }, "last": { "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" }, "next": { "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" }, "prev": { "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Create a new Swag Customized Products Template Option Value Price resources.", "description": "", "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-customized-products-template-option-value-price": { "post": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Search for the Swag Customized Products Template Option Value Price resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-customized-products-template-option-value-price/{id}": { "get": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", "description": "", "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Delete a Swag Customized Products Template Option Value Price resource.", "description": "", "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "description": "", "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-customized-products-template-option-value-price": { "post": { "tags": ["Swag Customized Products Template Option Value Price"], "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-delay-action": { "get": { "tags": ["Swag Delay Action"], "summary": "List with basic information of Swag Delay Action resources.", "description": "", "operationId": "getSwagDelayActionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Delay Action resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-delay-action?limit=25" }, "last": { "example": "/swag-delay-action?limit=25&page=11" }, "next": { "example": "/swag-delay-action?limit=25&page=4" }, "prev": { "example": "/swag-delay-action?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Delay Action"], "summary": "Create a new Swag Delay Action resources.", "description": "", "operationId": "createSwagDelayAction", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-delay-action": { "post": { "tags": ["Swag Delay Action"], "summary": "Search for the Swag Delay Action resources.", "description": "", "operationId": "searchSwagDelayAction", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-delay-action/{id}": { "get": { "tags": ["Swag Delay Action"], "summary": "Detailed information about a Swag Delay Action resource.", "description": "", "operationId": "getSwagDelayAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Delay Action"], "summary": "Delete a Swag Delay Action resource.", "description": "", "operationId": "deleteSwagDelayAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Delay Action"], "summary": "Partially update information about a Swag Delay Action resource.", "description": "", "operationId": "updateSwagDelayAction", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-delay-action": { "post": { "tags": ["Swag Delay Action"], "summary": "Aggregate for the Swag Delay Action resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagDelayAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagDelayAction" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-language-pack-language": { "get": { "tags": ["Swag Language Pack Language"], "summary": "List with basic information of Swag Language Pack Language resources.", "description": "", "operationId": "getSwagLanguagePackLanguageList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Language Pack 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/SwagLanguagePackLanguage" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-language-pack-language?limit=25" }, "last": { "example": "/swag-language-pack-language?limit=25&page=11" }, "next": { "example": "/swag-language-pack-language?limit=25&page=4" }, "prev": { "example": "/swag-language-pack-language?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Language Pack Language"], "summary": "Create a new Swag Language Pack Language resources.", "description": "", "operationId": "createSwagLanguagePackLanguage", "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/SwagLanguagePackLanguage" } } } }, "responses": { "200": { "description": "Detail of SwagLanguagePackLanguage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-language-pack-language": { "post": { "tags": ["Swag Language Pack Language"], "summary": "Search for the Swag Language Pack Language resources.", "description": "", "operationId": "searchSwagLanguagePackLanguage", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagLanguagePackLanguage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-language-pack-language/{id}": { "get": { "tags": ["Swag Language Pack Language"], "summary": "Detailed information about a Swag Language Pack Language resource.", "description": "", "operationId": "getSwagLanguagePackLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_language_pack_language", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagLanguagePackLanguage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Language Pack Language"], "summary": "Delete a Swag Language Pack Language resource.", "description": "", "operationId": "deleteSwagLanguagePackLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_language_pack_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Language Pack Language"], "summary": "Partially update information about a Swag Language Pack Language resource.", "description": "", "operationId": "updateSwagLanguagePackLanguage", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_language_pack_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 Swag Language Pack Language resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } }, "responses": { "200": { "description": "Detail of SwagLanguagePackLanguage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-language-pack-language": { "post": { "tags": ["Swag Language Pack Language"], "summary": "Aggregate for the Swag Language Pack Language resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagLanguagePackLanguage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagLanguagePackLanguage", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagLanguagePackLanguage" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-connection": { "get": { "tags": ["Swag Migration Connection"], "summary": "List with basic information of Swag Migration Connection resources.", "description": "", "operationId": "getSwagMigrationConnectionList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Connection resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-connection?limit=25" }, "last": { "example": "/swag-migration-connection?limit=25&page=11" }, "next": { "example": "/swag-migration-connection?limit=25&page=4" }, "prev": { "example": "/swag-migration-connection?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Connection"], "summary": "Create a new Swag Migration Connection resources.", "description": "", "operationId": "createSwagMigrationConnection", "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/SwagMigrationConnection" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationConnection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-connection": { "post": { "tags": ["Swag Migration Connection"], "summary": "Search for the Swag Migration Connection resources.", "description": "", "operationId": "searchSwagMigrationConnection", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationConnection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-connection/{id}": { "get": { "tags": ["Swag Migration Connection"], "summary": "Detailed information about a Swag Migration Connection resource.", "description": "", "operationId": "getSwagMigrationConnection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_connection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationConnection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Connection"], "summary": "Delete a Swag Migration Connection resource.", "description": "", "operationId": "deleteSwagMigrationConnection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_connection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Connection"], "summary": "Partially update information about a Swag Migration Connection resource.", "description": "", "operationId": "updateSwagMigrationConnection", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_connection", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Migration Connection resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationConnection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-connection": { "post": { "tags": ["Swag Migration Connection"], "summary": "Aggregate for the Swag Migration Connection resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationConnection", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationConnection", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationConnection" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-data": { "get": { "tags": ["Swag Migration Data"], "summary": "List with basic information of Swag Migration Data resources.", "description": "", "operationId": "getSwagMigrationDataList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Data resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-data?limit=25" }, "last": { "example": "/swag-migration-data?limit=25&page=11" }, "next": { "example": "/swag-migration-data?limit=25&page=4" }, "prev": { "example": "/swag-migration-data?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Data"], "summary": "Create a new Swag Migration Data resources.", "description": "", "operationId": "createSwagMigrationData", "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/SwagMigrationData" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationData", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-data": { "post": { "tags": ["Swag Migration Data"], "summary": "Search for the Swag Migration Data resources.", "description": "", "operationId": "searchSwagMigrationData", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationData", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-data/{id}": { "get": { "tags": ["Swag Migration Data"], "summary": "Detailed information about a Swag Migration Data resource.", "description": "", "operationId": "getSwagMigrationData", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_data", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationData", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Data"], "summary": "Delete a Swag Migration Data resource.", "description": "", "operationId": "deleteSwagMigrationData", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_data", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Data"], "summary": "Partially update information about a Swag Migration Data resource.", "description": "", "operationId": "updateSwagMigrationData", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_data", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Migration Data resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationData" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationData", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-data": { "post": { "tags": ["Swag Migration Data"], "summary": "Aggregate for the Swag Migration Data resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationData", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationData", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-general-setting": { "get": { "tags": ["Swag Migration General Setting"], "summary": "List with basic information of Swag Migration General Setting resources.", "description": "", "operationId": "getSwagMigrationGeneralSettingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration General 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/SwagMigrationGeneralSetting" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-general-setting?limit=25" }, "last": { "example": "/swag-migration-general-setting?limit=25&page=11" }, "next": { "example": "/swag-migration-general-setting?limit=25&page=4" }, "prev": { "example": "/swag-migration-general-setting?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration General Setting"], "summary": "Create a new Swag Migration General Setting resources.", "description": "", "operationId": "createSwagMigrationGeneralSetting", "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/SwagMigrationGeneralSetting" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationGeneralSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-general-setting": { "post": { "tags": ["Swag Migration General Setting"], "summary": "Search for the Swag Migration General Setting resources.", "description": "", "operationId": "searchSwagMigrationGeneralSetting", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationGeneralSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-general-setting/{id}": { "get": { "tags": ["Swag Migration General Setting"], "summary": "Detailed information about a Swag Migration General Setting resource.", "description": "", "operationId": "getSwagMigrationGeneralSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_general_setting", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationGeneralSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration General Setting"], "summary": "Delete a Swag Migration General Setting resource.", "description": "", "operationId": "deleteSwagMigrationGeneralSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_general_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration General Setting"], "summary": "Partially update information about a Swag Migration General Setting resource.", "description": "", "operationId": "updateSwagMigrationGeneralSetting", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_general_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 Swag Migration General Setting resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationGeneralSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-general-setting": { "post": { "tags": ["Swag Migration General Setting"], "summary": "Aggregate for the Swag Migration General Setting resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationGeneralSetting", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationGeneralSetting", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-logging": { "get": { "tags": ["Swag Migration Logging"], "summary": "List with basic information of Swag Migration Logging resources.", "description": "", "operationId": "getSwagMigrationLoggingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Logging resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-logging?limit=25" }, "last": { "example": "/swag-migration-logging?limit=25&page=11" }, "next": { "example": "/swag-migration-logging?limit=25&page=4" }, "prev": { "example": "/swag-migration-logging?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Logging"], "summary": "Create a new Swag Migration Logging resources.", "description": "", "operationId": "createSwagMigrationLogging", "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/SwagMigrationLogging" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationLogging", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-logging": { "post": { "tags": ["Swag Migration Logging"], "summary": "Search for the Swag Migration Logging resources.", "description": "", "operationId": "searchSwagMigrationLogging", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationLogging", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-logging/{id}": { "get": { "tags": ["Swag Migration Logging"], "summary": "Detailed information about a Swag Migration Logging resource.", "description": "", "operationId": "getSwagMigrationLogging", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_logging", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationLogging", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Logging"], "summary": "Delete a Swag Migration Logging resource.", "description": "", "operationId": "deleteSwagMigrationLogging", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_logging", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Logging"], "summary": "Partially update information about a Swag Migration Logging resource.", "description": "", "operationId": "updateSwagMigrationLogging", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_logging", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Migration Logging resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationLogging", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-logging": { "post": { "tags": ["Swag Migration Logging"], "summary": "Aggregate for the Swag Migration Logging resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationLogging", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationLogging", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-mapping": { "get": { "tags": ["Swag Migration Mapping"], "summary": "List with basic information of Swag Migration Mapping resources.", "description": "", "operationId": "getSwagMigrationMappingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Mapping resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-mapping?limit=25" }, "last": { "example": "/swag-migration-mapping?limit=25&page=11" }, "next": { "example": "/swag-migration-mapping?limit=25&page=4" }, "prev": { "example": "/swag-migration-mapping?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Mapping"], "summary": "Create a new Swag Migration Mapping resources.", "description": "", "operationId": "createSwagMigrationMapping", "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/SwagMigrationMapping" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-mapping": { "post": { "tags": ["Swag Migration Mapping"], "summary": "Search for the Swag Migration Mapping resources.", "description": "", "operationId": "searchSwagMigrationMapping", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-mapping/{id}": { "get": { "tags": ["Swag Migration Mapping"], "summary": "Detailed information about a Swag Migration Mapping resource.", "description": "", "operationId": "getSwagMigrationMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Mapping"], "summary": "Delete a Swag Migration Mapping resource.", "description": "", "operationId": "deleteSwagMigrationMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Mapping"], "summary": "Partially update information about a Swag Migration Mapping resource.", "description": "", "operationId": "updateSwagMigrationMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Migration Mapping resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-mapping": { "post": { "tags": ["Swag Migration Mapping"], "summary": "Aggregate for the Swag Migration Mapping resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationMapping", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-media-file": { "get": { "tags": ["Swag Migration Media File"], "summary": "List with basic information of Swag Migration Media File resources.", "description": "", "operationId": "getSwagMigrationMediaFileList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Media 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/SwagMigrationMediaFile" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-media-file?limit=25" }, "last": { "example": "/swag-migration-media-file?limit=25&page=11" }, "next": { "example": "/swag-migration-media-file?limit=25&page=4" }, "prev": { "example": "/swag-migration-media-file?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Media File"], "summary": "Create a new Swag Migration Media File resources.", "description": "", "operationId": "createSwagMigrationMediaFile", "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/SwagMigrationMediaFile" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationMediaFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-media-file": { "post": { "tags": ["Swag Migration Media File"], "summary": "Search for the Swag Migration Media File resources.", "description": "", "operationId": "searchSwagMigrationMediaFile", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationMediaFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-media-file/{id}": { "get": { "tags": ["Swag Migration Media File"], "summary": "Detailed information about a Swag Migration Media File resource.", "description": "", "operationId": "getSwagMigrationMediaFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_media_file", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationMediaFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Media File"], "summary": "Delete a Swag Migration Media File resource.", "description": "", "operationId": "deleteSwagMigrationMediaFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_media_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Media File"], "summary": "Partially update information about a Swag Migration Media File resource.", "description": "", "operationId": "updateSwagMigrationMediaFile", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_media_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 Swag Migration Media File resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationMediaFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-media-file": { "post": { "tags": ["Swag Migration Media File"], "summary": "Aggregate for the Swag Migration Media File resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationMediaFile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationMediaFile", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-run": { "get": { "tags": ["Swag Migration Run"], "summary": "List with basic information of Swag Migration Run resources.", "description": "", "operationId": "getSwagMigrationRunList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Migration Run resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-migration-run?limit=25" }, "last": { "example": "/swag-migration-run?limit=25&page=11" }, "next": { "example": "/swag-migration-run?limit=25&page=4" }, "prev": { "example": "/swag-migration-run?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Migration Run"], "summary": "Create a new Swag Migration Run resources.", "description": "", "operationId": "createSwagMigrationRun", "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/SwagMigrationRun" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-migration-run": { "post": { "tags": ["Swag Migration Run"], "summary": "Search for the Swag Migration Run resources.", "description": "", "operationId": "searchSwagMigrationRun", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagMigrationRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-migration-run/{id}": { "get": { "tags": ["Swag Migration Run"], "summary": "Detailed information about a Swag Migration Run resource.", "description": "", "operationId": "getSwagMigrationRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagMigrationRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Migration Run"], "summary": "Delete a Swag Migration Run resource.", "description": "", "operationId": "deleteSwagMigrationRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Migration Run"], "summary": "Partially update information about a Swag Migration Run resource.", "description": "", "operationId": "updateSwagMigrationRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_migration_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Migration Run resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagMigrationRun" } } } }, "responses": { "200": { "description": "Detail of SwagMigrationRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-migration-run": { "post": { "tags": ["Swag Migration Run"], "summary": "Aggregate for the Swag Migration Run resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagMigrationRun", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagMigrationRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel": { "get": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "List with basic information of Swag Paypal Pos Sales Channel resources.", "description": "", "operationId": "getSwagPaypalPosSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Pos 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/SwagPaypalPosSalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-pos-sales-channel?limit=25" }, "last": { "example": "/swag-paypal-pos-sales-channel?limit=25&page=11" }, "next": { "example": "/swag-paypal-pos-sales-channel?limit=25&page=4" }, "prev": { "example": "/swag-paypal-pos-sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Create a new Swag Paypal Pos Sales Channel resources.", "description": "", "operationId": "createSwagPaypalPosSalesChannel", "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/SwagPaypalPosSalesChannel" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-pos-sales-channel": { "post": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Search for the Swag Paypal Pos Sales Channel resources.", "description": "", "operationId": "searchSwagPaypalPosSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalPosSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel/{id}": { "get": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Detailed information about a Swag Paypal Pos Sales Channel resource.", "description": "", "operationId": "getSwagPaypalPosSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Delete a Swag Paypal Pos Sales Channel resource.", "description": "", "operationId": "deleteSwagPaypalPosSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Partially update information about a Swag Paypal Pos Sales Channel resource.", "description": "", "operationId": "updateSwagPaypalPosSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_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 Swag Paypal Pos Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-pos-sales-channel": { "post": { "tags": ["Swag Paypal Pos Sales Channel"], "summary": "Aggregate for the Swag Paypal Pos Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalPosSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalPosSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel-run": { "get": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "List with basic information of Swag Paypal Pos Sales Channel Run resources.", "description": "", "operationId": "getSwagPaypalPosSalesChannelRunList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Pos Sales Channel Run resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-pos-sales-channel-run?limit=25" }, "last": { "example": "/swag-paypal-pos-sales-channel-run?limit=25&page=11" }, "next": { "example": "/swag-paypal-pos-sales-channel-run?limit=25&page=4" }, "prev": { "example": "/swag-paypal-pos-sales-channel-run?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Create a new Swag Paypal Pos Sales Channel Run resources.", "description": "", "operationId": "createSwagPaypalPosSalesChannelRun", "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/SwagPaypalPosSalesChannelRun" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-pos-sales-channel-run": { "post": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Search for the Swag Paypal Pos Sales Channel Run resources.", "description": "", "operationId": "searchSwagPaypalPosSalesChannelRun", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalPosSalesChannelRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel-run/{id}": { "get": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Detailed information about a Swag Paypal Pos Sales Channel Run resource.", "description": "", "operationId": "getSwagPaypalPosSalesChannelRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Delete a Swag Paypal Pos Sales Channel Run resource.", "description": "", "operationId": "deleteSwagPaypalPosSalesChannelRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Partially update information about a Swag Paypal Pos Sales Channel Run resource.", "description": "", "operationId": "updateSwagPaypalPosSalesChannelRun", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Paypal Pos Sales Channel Run resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-pos-sales-channel-run": { "post": { "tags": ["Swag Paypal Pos Sales Channel Run"], "summary": "Aggregate for the Swag Paypal Pos Sales Channel Run resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalPosSalesChannelRun", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalPosSalesChannelRun", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel-run-log": { "get": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "List with basic information of Swag Paypal Pos Sales Channel Run Log resources.", "description": "", "operationId": "getSwagPaypalPosSalesChannelRunLogList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Pos Sales Channel Run 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/SwagPaypalPosSalesChannelRunLog" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-pos-sales-channel-run-log?limit=25" }, "last": { "example": "/swag-paypal-pos-sales-channel-run-log?limit=25&page=11" }, "next": { "example": "/swag-paypal-pos-sales-channel-run-log?limit=25&page=4" }, "prev": { "example": "/swag-paypal-pos-sales-channel-run-log?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Create a new Swag Paypal Pos Sales Channel Run Log resources.", "description": "", "operationId": "createSwagPaypalPosSalesChannelRunLog", "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/SwagPaypalPosSalesChannelRunLog" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRunLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-pos-sales-channel-run-log": { "post": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Search for the Swag Paypal Pos Sales Channel Run Log resources.", "description": "", "operationId": "searchSwagPaypalPosSalesChannelRunLog", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalPosSalesChannelRunLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-pos-sales-channel-run-log/{id}": { "get": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Detailed information about a Swag Paypal Pos Sales Channel Run Log resource.", "description": "", "operationId": "getSwagPaypalPosSalesChannelRunLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run_log", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRunLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Delete a Swag Paypal Pos Sales Channel Run Log resource.", "description": "", "operationId": "deleteSwagPaypalPosSalesChannelRunLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Partially update information about a Swag Paypal Pos Sales Channel Run Log resource.", "description": "", "operationId": "updateSwagPaypalPosSalesChannelRunLog", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_pos_sales_channel_run_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 Swag Paypal Pos Sales Channel Run Log resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalPosSalesChannelRunLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-pos-sales-channel-run-log": { "post": { "tags": ["Swag Paypal Pos Sales Channel Run Log"], "summary": "Aggregate for the Swag Paypal Pos Sales Channel Run Log resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalPosSalesChannelRunLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalPosSalesChannelRunLog", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-transaction-report": { "get": { "tags": ["Swag Paypal Transaction Report"], "summary": "List with basic information of Swag Paypal Transaction Report resources.", "description": "", "operationId": "getSwagPaypalTransactionReportList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Transaction Report resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-transaction-report?limit=25" }, "last": { "example": "/swag-paypal-transaction-report?limit=25&page=11" }, "next": { "example": "/swag-paypal-transaction-report?limit=25&page=4" }, "prev": { "example": "/swag-paypal-transaction-report?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Transaction Report"], "summary": "Create a new Swag Paypal Transaction Report resources.", "description": "", "operationId": "createSwagPaypalTransactionReport", "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/SwagPaypalTransactionReport" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalTransactionReport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-transaction-report": { "post": { "tags": ["Swag Paypal Transaction Report"], "summary": "Search for the Swag Paypal Transaction Report resources.", "description": "", "operationId": "searchSwagPaypalTransactionReport", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalTransactionReport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-transaction-report/{id}": { "get": { "tags": ["Swag Paypal Transaction Report"], "summary": "Detailed information about a Swag Paypal Transaction Report resource.", "description": "", "operationId": "getSwagPaypalTransactionReport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_transaction_report", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalTransactionReport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Transaction Report"], "summary": "Delete a Swag Paypal Transaction Report resource.", "description": "", "operationId": "deleteSwagPaypalTransactionReport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_transaction_report", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Transaction Report"], "summary": "Partially update information about a Swag Paypal Transaction Report resource.", "description": "", "operationId": "updateSwagPaypalTransactionReport", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_transaction_report", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Paypal Transaction Report resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalTransactionReport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-transaction-report": { "post": { "tags": ["Swag Paypal Transaction Report"], "summary": "Aggregate for the Swag Paypal Transaction Report resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalTransactionReport", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalTransactionReport", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalTransactionReport" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-vault-token": { "get": { "tags": ["Swag Paypal Vault Token"], "summary": "List with basic information of Swag Paypal Vault Token resources.", "description": "", "operationId": "getSwagPaypalVaultTokenList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Vault Token resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-vault-token?limit=25" }, "last": { "example": "/swag-paypal-vault-token?limit=25&page=11" }, "next": { "example": "/swag-paypal-vault-token?limit=25&page=4" }, "prev": { "example": "/swag-paypal-vault-token?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Vault Token"], "summary": "Create a new Swag Paypal Vault Token resources.", "description": "", "operationId": "createSwagPaypalVaultToken", "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/SwagPaypalVaultToken" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalVaultToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-vault-token": { "post": { "tags": ["Swag Paypal Vault Token"], "summary": "Search for the Swag Paypal Vault Token resources.", "description": "", "operationId": "searchSwagPaypalVaultToken", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalVaultToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-vault-token/{id}": { "get": { "tags": ["Swag Paypal Vault Token"], "summary": "Detailed information about a Swag Paypal Vault Token resource.", "description": "", "operationId": "getSwagPaypalVaultToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalVaultToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Vault Token"], "summary": "Delete a Swag Paypal Vault Token resource.", "description": "", "operationId": "deleteSwagPaypalVaultToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Vault Token"], "summary": "Partially update information about a Swag Paypal Vault Token resource.", "description": "", "operationId": "updateSwagPaypalVaultToken", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Paypal Vault Token resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalVaultToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-vault-token": { "post": { "tags": ["Swag Paypal Vault Token"], "summary": "Aggregate for the Swag Paypal Vault Token resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalVaultToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalVaultToken", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-vault-token-mapping": { "get": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "List with basic information of Swag Paypal Vault Token Mapping resources.", "description": "", "operationId": "getSwagPaypalVaultTokenMappingList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Paypal Vault Token Mapping resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-paypal-vault-token-mapping?limit=25" }, "last": { "example": "/swag-paypal-vault-token-mapping?limit=25&page=11" }, "next": { "example": "/swag-paypal-vault-token-mapping?limit=25&page=4" }, "prev": { "example": "/swag-paypal-vault-token-mapping?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Create a new Swag Paypal Vault Token Mapping resources.", "description": "", "operationId": "createSwagPaypalVaultTokenMapping", "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/SwagPaypalVaultTokenMapping" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalVaultTokenMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-paypal-vault-token-mapping": { "post": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Search for the Swag Paypal Vault Token Mapping resources.", "description": "", "operationId": "searchSwagPaypalVaultTokenMapping", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagPaypalVaultTokenMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-paypal-vault-token-mapping/{id}": { "get": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Detailed information about a Swag Paypal Vault Token Mapping resource.", "description": "", "operationId": "getSwagPaypalVaultTokenMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagPaypalVaultTokenMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Delete a Swag Paypal Vault Token Mapping resource.", "description": "", "operationId": "deleteSwagPaypalVaultTokenMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Partially update information about a Swag Paypal Vault Token Mapping resource.", "description": "", "operationId": "updateSwagPaypalVaultTokenMapping", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_paypal_vault_token_mapping", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Paypal Vault Token Mapping resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } }, "responses": { "200": { "description": "Detail of SwagPaypalVaultTokenMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-paypal-vault-token-mapping": { "post": { "tags": ["Swag Paypal Vault Token Mapping"], "summary": "Aggregate for the Swag Paypal Vault Token Mapping resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagPaypalVaultTokenMapping", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagPaypalVaultTokenMapping", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-customer": { "get": { "tags": ["Swag Social Shopping Customer"], "summary": "List with basic information of Swag Social Shopping Customer resources.", "description": "", "operationId": "getSwagSocialShoppingCustomerList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Social Shopping 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/SwagSocialShoppingCustomer" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-social-shopping-customer?limit=25" }, "last": { "example": "/swag-social-shopping-customer?limit=25&page=11" }, "next": { "example": "/swag-social-shopping-customer?limit=25&page=4" }, "prev": { "example": "/swag-social-shopping-customer?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Social Shopping Customer"], "summary": "Create a new Swag Social Shopping Customer resources.", "description": "", "operationId": "createSwagSocialShoppingCustomer", "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/SwagSocialShoppingCustomer" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-social-shopping-customer": { "post": { "tags": ["Swag Social Shopping Customer"], "summary": "Search for the Swag Social Shopping Customer resources.", "description": "", "operationId": "searchSwagSocialShoppingCustomer", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagSocialShoppingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-customer/{id}": { "get": { "tags": ["Swag Social Shopping Customer"], "summary": "Detailed information about a Swag Social Shopping Customer resource.", "description": "", "operationId": "getSwagSocialShoppingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_customer", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagSocialShoppingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Social Shopping Customer"], "summary": "Delete a Swag Social Shopping Customer resource.", "description": "", "operationId": "deleteSwagSocialShoppingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Social Shopping Customer"], "summary": "Partially update information about a Swag Social Shopping Customer resource.", "description": "", "operationId": "updateSwagSocialShoppingCustomer", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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 Swag Social Shopping Customer resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-social-shopping-customer": { "post": { "tags": ["Swag Social Shopping Customer"], "summary": "Aggregate for the Swag Social Shopping Customer resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagSocialShoppingCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagSocialShoppingCustomer", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingCustomer" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-order": { "get": { "tags": ["Swag Social Shopping Order"], "summary": "List with basic information of Swag Social Shopping Order resources.", "description": "", "operationId": "getSwagSocialShoppingOrderList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Social Shopping 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/SwagSocialShoppingOrder" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-social-shopping-order?limit=25" }, "last": { "example": "/swag-social-shopping-order?limit=25&page=11" }, "next": { "example": "/swag-social-shopping-order?limit=25&page=4" }, "prev": { "example": "/swag-social-shopping-order?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Social Shopping Order"], "summary": "Create a new Swag Social Shopping Order resources.", "description": "", "operationId": "createSwagSocialShoppingOrder", "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/SwagSocialShoppingOrder" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-social-shopping-order": { "post": { "tags": ["Swag Social Shopping Order"], "summary": "Search for the Swag Social Shopping Order resources.", "description": "", "operationId": "searchSwagSocialShoppingOrder", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagSocialShoppingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-order/{id}": { "get": { "tags": ["Swag Social Shopping Order"], "summary": "Detailed information about a Swag Social Shopping Order resource.", "description": "", "operationId": "getSwagSocialShoppingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_order", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagSocialShoppingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Social Shopping Order"], "summary": "Delete a Swag Social Shopping Order resource.", "description": "", "operationId": "deleteSwagSocialShoppingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Social Shopping Order"], "summary": "Partially update information about a Swag Social Shopping Order resource.", "description": "", "operationId": "updateSwagSocialShoppingOrder", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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 Swag Social Shopping Order resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-social-shopping-order": { "post": { "tags": ["Swag Social Shopping Order"], "summary": "Aggregate for the Swag Social Shopping Order resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagSocialShoppingOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagSocialShoppingOrder", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingOrder" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-product-error": { "get": { "tags": ["Swag Social Shopping Product Error"], "summary": "List with basic information of Swag Social Shopping Product Error resources.", "description": "", "operationId": "getSwagSocialShoppingProductErrorList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Social Shopping Product Error resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-social-shopping-product-error?limit=25" }, "last": { "example": "/swag-social-shopping-product-error?limit=25&page=11" }, "next": { "example": "/swag-social-shopping-product-error?limit=25&page=4" }, "prev": { "example": "/swag-social-shopping-product-error?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Social Shopping Product Error"], "summary": "Create a new Swag Social Shopping Product Error resources.", "description": "", "operationId": "createSwagSocialShoppingProductError", "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/SwagSocialShoppingProductError" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingProductError", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-social-shopping-product-error": { "post": { "tags": ["Swag Social Shopping Product Error"], "summary": "Search for the Swag Social Shopping Product Error resources.", "description": "", "operationId": "searchSwagSocialShoppingProductError", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagSocialShoppingProductError", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-product-error/{id}": { "get": { "tags": ["Swag Social Shopping Product Error"], "summary": "Detailed information about a Swag Social Shopping Product Error resource.", "description": "", "operationId": "getSwagSocialShoppingProductError", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_product_error", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagSocialShoppingProductError", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Social Shopping Product Error"], "summary": "Delete a Swag Social Shopping Product Error resource.", "description": "", "operationId": "deleteSwagSocialShoppingProductError", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_product_error", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Social Shopping Product Error"], "summary": "Partially update information about a Swag Social Shopping Product Error resource.", "description": "", "operationId": "updateSwagSocialShoppingProductError", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_product_error", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Swag Social Shopping Product Error resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingProductError", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-social-shopping-product-error": { "post": { "tags": ["Swag Social Shopping Product Error"], "summary": "Aggregate for the Swag Social Shopping Product Error resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagSocialShoppingProductError", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagSocialShoppingProductError", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingProductError" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-sales-channel": { "get": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "List with basic information of Swag Social Shopping Sales Channel resources.", "description": "", "operationId": "getSwagSocialShoppingSalesChannelList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Swag Social Shopping 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/SwagSocialShoppingSalesChannel" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/swag-social-shopping-sales-channel?limit=25" }, "last": { "example": "/swag-social-shopping-sales-channel?limit=25&page=11" }, "next": { "example": "/swag-social-shopping-sales-channel?limit=25&page=4" }, "prev": { "example": "/swag-social-shopping-sales-channel?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Create a new Swag Social Shopping Sales Channel resources.", "description": "", "operationId": "createSwagSocialShoppingSalesChannel", "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/SwagSocialShoppingSalesChannel" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/swag-social-shopping-sales-channel": { "post": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Search for the Swag Social Shopping Sales Channel resources.", "description": "", "operationId": "searchSwagSocialShoppingSalesChannel", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default 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 SwagSocialShoppingSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/swag-social-shopping-sales-channel/{id}": { "get": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Detailed information about a Swag Social Shopping Sales Channel resource.", "description": "", "operationId": "getSwagSocialShoppingSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_sales_channel", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of SwagSocialShoppingSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Delete a Swag Social Shopping Sales Channel resource.", "description": "", "operationId": "deleteSwagSocialShoppingSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Partially update information about a Swag Social Shopping Sales Channel resource.", "description": "", "operationId": "updateSwagSocialShoppingSalesChannel", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the swag_social_shopping_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 Swag Social Shopping Sales Channel resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } }, "responses": { "200": { "description": "Detail of SwagSocialShoppingSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/swag-social-shopping-sales-channel": { "post": { "tags": ["Swag Social Shopping Sales Channel"], "summary": "Aggregate for the Swag Social Shopping Sales Channel resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateSwagSocialShoppingSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of SwagSocialShoppingSalesChannel", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagSocialShoppingSalesChannel" } } } } } } }, "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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/warehouse": { "get": { "tags": ["Warehouse"], "summary": "List with basic information of Warehouse resources.", "description": "", "operationId": "getWarehouseList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/warehouse?limit=25" }, "last": { "example": "/warehouse?limit=25&page=11" }, "next": { "example": "/warehouse?limit=25&page=4" }, "prev": { "example": "/warehouse?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Warehouse"], "summary": "Create a new Warehouse resources.", "description": "", "operationId": "createWarehouse", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/warehouse": { "post": { "tags": ["Warehouse"], "summary": "Search for the Warehouse resources.", "description": "", "operationId": "searchWarehouse", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/warehouse/{id}": { "get": { "tags": ["Warehouse"], "summary": "Detailed information about a Warehouse resource.", "description": "", "operationId": "getWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Warehouse"], "summary": "Delete a Warehouse resource.", "description": "", "operationId": "deleteWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Warehouse"], "summary": "Partially update information about a Warehouse resource.", "description": "", "operationId": "updateWarehouse", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Warehouse resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } }, "responses": { "200": { "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/Warehouse" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/warehouse": { "post": { "tags": ["Warehouse"], "summary": "Aggregate for the Warehouse resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateWarehouse", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/warehouse-group": { "get": { "tags": ["Warehouse Group"], "summary": "List with basic information of Warehouse Group resources.", "description": "", "operationId": "getWarehouseGroupList", "parameters": [ { "name": "limit", "in": "query", "description": "Max amount of resources to be returned in a page", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "The page to be returned", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "description": "Encoded SwagQL in JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/data" }, { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } ] }, "links": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "first": { "example": "/warehouse-group?limit=25" }, "last": { "example": "/warehouse-group?limit=25&page=11" }, "next": { "example": "/warehouse-group?limit=25&page=4" }, "prev": { "example": "/warehouse-group?limit=25&page=2" } } } ] } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } } }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": ["Warehouse Group"], "summary": "Create a new Warehouse Group resources.", "description": "", "operationId": "createWarehouseGroup", "parameters": [ { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", "enum": ["basic", "detail"] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseGroup" } } } }, "responses": { "200": { "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/search/warehouse-group": { "post": { "tags": ["Warehouse Group"], "summary": "Search for the Warehouse Group resources.", "description": "", "operationId": "searchWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", "in": "header", "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", "enum": ["0", "1"], "default": "1" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/warehouse-group/{id}": { "get": { "tags": ["Warehouse Group"], "summary": "Detailed information about a Warehouse Group resource.", "description": "", "operationId": "getWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "delete": { "tags": ["Warehouse Group"], "summary": "Delete a Warehouse Group resource.", "description": "", "operationId": "deleteWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/204" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "patch": { "tags": ["Warehouse Group"], "summary": "Partially update information about a Warehouse Group resource.", "description": "", "operationId": "updateWarehouseGroup", "parameters": [ { "name": "id", "in": "path", "description": "Identifier for the warehouse_group", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "_response", "in": "query", "description": "Data format for response. Empty if none is provided.", "allowEmptyValue": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Partially update information about a Warehouse Group resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseGroup" } } } }, "responses": { "200": { "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } ] } }, "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/aggregate/warehouse-group": { "post": { "tags": ["Warehouse Group"], "summary": "Aggregate for the Warehouse Group resources.", "description": "Available since: 6.6.10.0", "operationId": "aggregateWarehouseGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } } }, "required": ["aggregations"] } } } }, "responses": { "200": { "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/success" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } } } ] } }, "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } } } }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } }, "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" }, "401": { "$ref": "#/components/responses/401" }, "404": { "$ref": "#/components/responses/404" } } } }, "/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" } } } }, "/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/cache": { "delete": { "tags": ["System Operations"], "summary": "Clear caches", "description": "The cache is immediately cleared synchronously for all used adapters.", "operationId": "clearCache", "responses": { "204": { "description": "Returns a no content response indicating that the cache has been cleared." } } } }, "/_action/cache-delayed": { "delete": { "tags": ["System Operations"], "summary": "Clear all invalidated caches", "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", "operationId": "clearCacheDelayed", "responses": { "204": { "description": "Returns a no content response indicating that the cache has been cleared." } } } }, "/_action/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/cleanup": { "delete": { "tags": ["System Operations"], "summary": "Clear old cache folders", "description": "Removes cache folders that are not needed anymore.", "operationId": "clearOldCacheFolders", "responses": { "204": { "description": "Returns a no content response indicating that the cleanup finished." } } } }, "/_info/config": { "get": { "tags": ["System Info & Health Check"], "summary": "Get public runtime config & feature metadata", "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", "operationId": "config", "responses": { "200": { "description": "Public runtime configuration & feature metadata returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infoConfigResponse" }, "example": { "version": "6.7.2.0", "shopId": "NoiU8PfJtu7NBY8M", "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", "adminWorker": { "enableAdminWorker": true, "enableQueueStatsWorker": true, "enableNotificationWorker": true, "transports": ["async", "low_priority"] }, "bundles": { "Administration": { "css": [ "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" ], "js": [ "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" ], "baseUrl": null, "type": "plugin" }, "Storefront": { "css": [ "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" ], "js": [ "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" ], "baseUrl": null, "type": "plugin" } }, "settings": { "enableUrlFeature": true, "appUrlReachable": true, "appsRequireAppUrl": false, "private_allowed_extensions": [ "jpg", "jpeg", "png", "webp", "avif", "gif", "svg", "bmp", "tiff", "tif", "eps", "webm", "mkv", "flv", "ogv", "ogg", "mov", "mp4", "avi", "wmv", "pdf", "aac", "mp3", "wav", "flac", "oga", "wma", "txt", "doc", "docx", "ico", "glb", "zip", "rar", "csv", "xls", "xlsx", "html", "xml" ], "enableHtmlSanitizer": true, "enableStagingMode": false, "disableExtensionManagement": false }, "inAppPurchases": [] } } } } } } }, "/_action/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." } } } }, "/_proxy/generate-imitate-customer-token": { "post": { "tags": ["Customer impersonation"], "summary": "Generate a customer impersonation token", "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["customerId", "salesChannelId"], "properties": { "customerId": { "description": "ID of the customer", "type": "string" }, "salesChannelId": { "description": "ID of the sales channel", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { "properties": { "token": { "description": "The generated customer impersonation token", "type": "string" } }, "type": "object" } } } } } } }, "/_action/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" } } } } } } }, "/_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" } } } } } } }, "/_info/flow-actions.json": { "get": { "tags": ["System Info & Health Check"], "summary": "Get actions for flow builder", "description": "Get a list of action for flow builder.", "operationId": "flow-actions", "responses": { "200": { "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } } } } }, "/_info/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/increment/{pool}": { "post": { "tags": ["Increment Storage"], "summary": "Increment a value in the specified pool", "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", "operationId": "incrementValue", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Optional cluster identifier for the increment operation.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["key"], "properties": { "key": { "type": "string", "description": "The key to increment in the pool." } } } } } }, "responses": { "200": { "description": "Successfully incremented the value", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - key parameter missing or cluster parameter missing" } } }, "get": { "tags": ["Increment Storage"], "summary": "List increment values from pool", "description": "Retrieves a list of increment values from the specified pool with pagination support.", "operationId": "getIncrementValues", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to list values from.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the increment operation.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of items to return.", "required": false, "schema": { "type": "integer", "default": 5, "minimum": 1 } }, { "name": "offset", "in": "query", "description": "Number of items to skip for pagination.", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } } ], "responses": { "200": { "description": "List of increment values", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The increment key" }, "count": { "type": "integer", "description": "The current count value" } } } } } } }, "400": { "description": "Bad request - cluster parameter missing" } } } }, "/_action/decrement/{pool}": { "post": { "tags": ["Increment Storage"], "summary": "Decrement a value in the specified pool", "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", "operationId": "decrementValue", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Optional cluster identifier for the decrement operation.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["key"], "properties": { "key": { "type": "string", "description": "The key to decrement in the pool." } } } } } }, "responses": { "200": { "description": "Successfully decremented the value", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, "/_action/reset-increment/{pool}": { "post": { "tags": ["Increment Storage"], "summary": "Reset increment values in pool", "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", "operationId": "resetIncrementValues", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to reset.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the reset operation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." } } } } } }, "responses": { "200": { "description": "Successfully reset the increment values", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } }, "400": { "description": "Bad request - cluster parameter missing" } } } }, "/_action/delete-increment/{pool}": { "delete": { "tags": ["Increment Storage"], "summary": "Delete increment keys from pool", "description": "Deletes specific increment keys from the specified pool.", "operationId": "deleteIncrementKeys", "parameters": [ { "name": "pool", "in": "path", "description": "The name of the increment pool to delete keys from.", "required": true, "schema": { "type": "string" } }, { "name": "cluster", "in": "query", "description": "Cluster identifier for the delete operation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["keys"], "properties": { "keys": { "type": "array", "items": { "type": "string" }, "description": "Array of keys to delete from the pool." } } } } } }, "responses": { "204": { "description": "Successfully deleted the increment keys" }, "400": { "description": "Bad request - invalid keys parameter or cluster parameter missing" } } } }, "/_action/index-products": { "post": { "tags": ["System Operations"], "summary": "Send product indexing message", "description": "Dispatches a product indexing message to the message bus, with the provided ids", "operationId": "productIndexing", "responses": { "204": { "description": "Returns an empty response indicating that the message dispatched." } } } }, "/_action/index": { "post": { "tags": ["System Operations"], "summary": "Run indexer", "description": "Runs all registered indexer in the shop asynchronously.", "operationId": "index", "requestBody": { "content": { "application/json": { "schema": { "properties": { "skip": { "description": "Array of indexers/updaters to be skipped.", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Returns a no content response indicating that the indexing progress startet." } } } }, "/_action/indexing": { "post": { "tags": ["System Operations"], "summary": "Run indexer", "description": "Runs all registered indexer in the shop asynchronously.", "operationId": "indexing", "responses": { "200": { "description": "Returns an empty response indicating that the indexing process started." } } } }, "/_action/indexing/{indexer}": { "post": { "tags": ["System Operations"], "summary": "Iterate an indexer", "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", "operationId": "iterate", "parameters": [ { "name": "indexer", "in": "path", "description": "Name of the indexer to iterate.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "offset": { "description": "The offset for the iteration.", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { "properties": { "finish": { "description": "Indicates if the indexing process finished.", "type": "boolean" }, "offset": { "description": "Offset to be used for the next iteration.", "type": "integer" } }, "type": "object" } } } } } } }, "/_info/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/mail-template/send": { "post": { "tags": ["Mail Operations"], "summary": "Send a mail", "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", "operationId": "send", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "recipients", "salesChannelId", "contentHtml", "contentPlain", "subject", "senderName" ], "properties": { "recipients": { "description": "A list of recipients with name and mail address.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient.", "type": "string" } }, "salesChannelId": { "description": "Identifier of the sales channel from which the mail should be send.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "contentHtml": { "description": "The content of the mail in HTML format.", "type": "string" }, "contentPlain": { "description": "The content of the mail as plain text.", "type": "string" }, "subject": { "description": "Subject of the mail.", "type": "string" }, "senderName": { "description": "Name of the sender.", "type": "string" }, "senderEmail": { "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", "type": "string" }, "mediaIds": { "description": "List of media identifiers which should be attached to the mail.", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "binAttachments": { "description": "A list of binary attachments which should be added to the mail.", "required": ["content", "fileName", "mimeType"], "type": "array", "items": { "properties": { "content": { "description": "Binary content of the attachment.", "type": "string" }, "fileName": { "description": "File name of the attachment.", "type": "string" }, "mimeType": { "description": "Mime type of the attachment.", "type": "string" } }, "type": "object" } }, "recipientsBcc": { "description": "A list of recipients with name and mail address to be set in BCC.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient.", "type": "string" } }, "recipientsCc": { "description": "A list of recipients with name and mail address to be set in CC.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient.", "type": "string" } }, "replyTo": { "description": "A list of mail addresses with name and mail address to be set in reply to.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient.", "type": "string" } }, "returnPath": { "description": "A list of mail addresses with name and mail address to be set in return path.", "type": "object", "example": { "test1@example.com": "Test user 1", "test2@example.com": "Test user 2" }, "additionalProperties": { "description": "Name of the recipient.", "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "The mail was sent successful", "content": { "application/json": { "schema": { "properties": { "size": { "description": "Length of the email message", "type": "integer" } }, "type": "object" } } } } } } }, "/_action/mail-template/validate": { "post": { "tags": ["Mail Operations"], "summary": "Validate a mail content", "description": "Validates if content for a mail can be rendered without sending an email.", "operationId": "validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["contentHtml", "contentPlain"], "properties": { "contentHtml": { "description": "The content of the mail in HTML format.", "type": "string" }, "contentPlain": { "description": "The content of the mail as plain text.", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, "/_action/mail-template/build": { "post": { "tags": ["Mail Operations"], "summary": "Preview a mail template", "description": "Generates a preview of a mail template.", "operationId": "build", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["mailTemplateType", "mailTemplate"], "properties": { "mailTemplateType": { "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", "properties": { "templateData": { "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", "type": "object", "example": { "order": { "orderNumber": 5000, "customerName": "Example Customer" }, "messageOfTheDay": "An apple a day keeps the doctor away!" }, "additionalProperties": true } }, "type": "object" }, "mailTemplate": { "description": "The content of the mail as plain text.", "properties": { "contentHtml": { "description": "The content of mail mail template in html format.", "type": "string", "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/_action/media/{mediaId}/upload": { "post": { "tags": ["Asset Management"], "summary": "Upload a file to a media entity", "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", "operationId": "upload", "parameters": [ { "name": "mediaId", "in": "path", "description": "Identifier of the media entity.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "fileName", "in": "query", "description": "Name of the uploaded file. If not provided the media identifier will be used as name", "schema": { "type": "string" } }, { "name": "extension", "in": "query", "description": "Extension of the uploaded file. For example `png`", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "required": ["url"], "properties": { "url": { "description": "The url of the media file that will be downloaded.", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Media file uploaded successful", "headers": { "Location": { "description": "Contains the url to the uploaded media for a redirect.", "schema": { "type": "string" } } } } } } }, "/_action/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" } }, "required": ["url", "mimeType"] } } } }, "responses": { "200": { "description": "External media link created successfully", "content": { "application\\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "ID of the created media entity" } } } } } } } } }, "/_action/media/{mediaId}/video-cover": { "post": { "tags": ["Asset Management"], "summary": "Assign or remove a video cover image", "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", "operationId": "assignVideoCover", "parameters": [ { "name": "mediaId", "in": "path", "required": true, "description": "ID of the video media entity", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "coverMediaId": { "type": ["string", "null"], "pattern": "^[0-9a-f]{32}$", "description": "ID of the image media entity to use as cover. Set to null to remove the cover." } } } } } }, "responses": { "204": { "description": "Video cover assigned or removed successfully" }, "400": { "description": "Invalid request" } } } }, "/_action/message-queue/consume": { "post": { "tags": ["System Operations"], "summary": "Consume messages from the message queue.", "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", "operationId": "consumeMessages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["receiver"], "properties": { "receiver": { "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about handled messages", "content": { "application/json": { "schema": { "properties": { "handledMessages": { "description": "The number of messages processed.", "type": "integer" } }, "type": "object" } } } } } } }, "/_info/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/number-range/reserve/{type}/{saleschannel}": { "get": { "tags": ["Document Management"], "summary": "Reserve or preview a document number", "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", "operationId": "numberRangeReserve", "parameters": [ { "name": "type", "in": "path", "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", "required": true, "schema": { "type": "string" } }, { "name": "saleschannel", "in": "path", "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", "required": true, "schema": { "type": "string" } }, { "name": "preview", "in": "query", "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The generated number", "content": { "application/json": { "schema": { "properties": { "number": { "description": "The generated (or previewed) document number.", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Number range not found" } } } }, "/_info/openapi3.json": { "get": { "tags": ["System Info & Health Check"], "summary": "Get OpenAPI Specification", "description": "Get information about the admin API in OpenAPI format.", "operationId": "api-info", "parameters": [ { "name": "type", "in": "query", "description": "Type of the api", "schema": { "type": "string", "enum": ["jsonapi", "json"] } } ], "responses": { "200": { "$ref": "#/components/responses/OpenApi3" } } } }, "/_action/order/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" } }, "type": "object" } } } }, "responses": { "200": { "description": "Todo: Use ref of `state_machine_transition` here" } } } }, "/_action/order/{orderId}/order-address": { "post": { "tags": ["Order address"], "summary": "Update order addresses", "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", "operationId": "updateOrderAddresses", "parameters": [ { "name": "orderId", "in": "path", "description": "Identifier of the order.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mapping": { "type": "array", "items": { "type": "object", "properties": { "customerAddressId": { "type": "string", "description": "The ID of the customer address" }, "type": { "type": "string", "description": "The type of the address" }, "deliveryId": { "description": "The ID of the delivery (optional)", "oneOf": [{ "type": "string" }, { "type": "null" }] } }, "required": ["customerAddressId", "type"] }, "description": "The mapping of order addresses" } } } } }, "required": true }, "responses": { "204": { "description": "Returns a no content response indicating that the update has been made." } } } }, "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": ["Order Management"], "summary": "Transition an order delivery to a new state", "description": "Changes the order delivery state and informs the customer via email if configured.", "operationId": "orderDeliveryStateTransition", "parameters": [ { "name": "orderDeliveryId", "in": "path", "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "transition", "in": "path", "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "sendMail": { "description": "Controls if a mail should be send to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "mediaIds": { "description": "A list of media identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "stateFieldName": { "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" } }, "type": "object" } } } }, "responses": { "200": { "description": "Todo: Use ref of `state_machine_transition` here" } } } }, "/_action/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" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, "/_action/order_transaction_capture_refund/{refundId}": { "post": { "tags": ["Order Management"], "summary": "Refund an order transaction capture", "description": "Refunds an order transaction capture.", "operationId": "orderTransactionCaptureRefund", "parameters": [ { "name": "refundId", "in": "path", "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Refund was successful" }, "400": { "description": "Something went wrong, while processing the refund" }, "404": { "description": "Refund with id not found" } } } }, "/_action/scheduled-task/run": { "post": { "tags": ["System Operations"], "summary": "Run scheduled tasks.", "description": "Starts the scheduled task worker to handle the next scheduled tasks.", "operationId": "runScheduledTasks", "responses": { "200": { "description": "Returns a success message indicating a successful run.", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Success message", "type": "string" } }, "type": "object" } } } } } } }, "/_action/scheduled-task/min-run-interval": { "get": { "tags": ["System Operations"], "summary": "Get the minimum schedules task interval", "description": "Fetches the smallest interval that a scheduled task uses.", "operationId": "getMinRunInterval", "responses": { "200": { "description": "Returns the minimum interval.", "content": { "application/json": { "schema": { "properties": { "minRunInterval": { "description": "Minimal interval in seconds.", "type": "string" } }, "type": "object" } } } } } } }, "/oauth/sso/config": { "get": { "tags": ["Authorization & Authentication", "SSO Login configuration"], "summary": "Loads configuration for the admin login", "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", "operationId": "loadSsoLoginConfig", "responses": { "200": { "description": "Config loaded successfully.", "content": { "application/json": { "schema": { "properties": { "useDefault": { "description": "Experimental: Indicates which login is used. Default or SSO.", "type": "boolean" }, "url": { "description": "Experimental: Contains the return url for the Shopware SSO login.", "type": "string" } }, "type": "object" } } } } } } }, "/oauth/sso/code": { "get": { "tags": ["Authorization & Authentication", "SSO Login callback"], "summary": "Callback function. Fetch an authorization code", "description": "Fetch an authorization code log in the user.", "operationId": "callBackWithCode", "responses": { "200": { "description": "Authorisation process continues", "content": { "application/json": { "schema": { "type": "object" } } } }, "302": { "description": "Experimental: Forwards to the Shopware admin" } } } }, "/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/sync": { "post": { "tags": ["Bulk Operations"], "summary": "Bulk edit entities", "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", "operationId": "sync", "parameters": [ { "name": "fail-on-error", "in": "header", "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { "type": "boolean", "default": true } }, { "name": "indexing-behavior", "in": "header", "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", "schema": { "type": "string", "enum": ["use-queue-indexing", "disable-indexing"] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "required": ["action", "entity", "payload"], "properties": { "action": { "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", "type": "string", "enum": ["upsert", "delete"] }, "entity": { "description": "The entity that should be processed with the payload.", "type": "string", "example": "product" }, "payload": { "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", "type": "array", "items": { "type": "object" } }, "filter": { "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } } }, "type": "object" } } } } }, "responses": { "200": { "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Object with information about updated entities", "type": "object" }, "notFound": { "description": "Object with information about not found entities", "type": "object" }, "deleted": { "description": "Object with information about deleted entities", "type": "object" } }, "type": "object" } } } } } } }, "/oauth/token": { "post": { "tags": ["Authorization & Authentication"], "summary": "Fetch an access token", "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", "operationId": "token", "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OAuthPasswordGrant" }, { "$ref": "#/components/schemas/OAuthRefreshTokenGrant" }, { "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } ] } } } }, "responses": { "200": { "description": "Authorized successfully.", "content": { "application/json": { "schema": { "required": ["token_type", "expires_in", "access_token"], "properties": { "token_type": { "description": "Type of the token.", "type": "string" }, "expires_in": { "description": "Token lifetime in seconds.", "type": "integer" }, "access_token": { "description": "The access token that can be used for subsequent requests", "type": "string" }, "refresh_token": { "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/400" } } } }, "/_info/version": { "get": { "tags": ["System Info & Health Check"], "summary": "Get the Shopware version", "description": "Get the version of the Shopware instance", "operationId": "infoShopwareVersion", "responses": { "200": { "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { "properties": { "version": { "description": "The Shopware version.", "type": "string" } }, "type": "object" } } } } } } }, "/_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"] } } } } } } }, "/_action/custom-price": { "post": { "tags": ["Bulk Operations"], "summary": "Bulk edit custom prices", "description": "An emulation of Sync API implementation", "operationId": "customPriceImport", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CustomPricingUpsertOperation" }, { "$ref": "#/components/schemas/CustomPricingDeleteOperation" } ] } } } } }, "responses": { "200": { "description": "Returns a JSON result containing information about the updated entities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomPricingResponse" } } } } } } }, "/api/_admin/rule-builder-preview/{orderId}": { "post": { "tags": ["Rule Preview"], "summary": "Preview results of a rule evaluating an order", "description": "Evaluate the conditions of a rule based on a pre-selected order.", "operationId": "rulePreview", "parameters": [ { "name": "orderId", "in": "path", "description": "Identifier of the order the preview should be generated for", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["conditions"], "properties": { "conditions": { "description": "Array of nested rule condition payloads.", "items": { "type": "object" }, "type": "array" }, "dateTime": { "description": "A date and time to be mocked in the preview evaluation.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the results of the evaluated rule conditions as an object.", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "match": { "description": "Evaluation of the condition", "type": "boolean" }, "name": { "description": "The technical name of the condition", "type": "string" }, "ruleReferenceId": { "description": "The id of the corresponding rule_condition entity", "type": "string" } }, "type": "object" } } } } } } } }, "/api/_action/generate-review-summary": { "post": { "summary": "Generate review summaries for products", "description": "Generate review summaries using the ReviewSummary service. Request body accepts mood, productId, salesChannelId and languageIds.", "operationId": "generateReviewSummary", "tags": ["ReviewSummary"], "requestBody": { "description": "Options for review summary generation.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Options" }, "example": { "mood": "positive", "productId": "019970d61cf071b481145788abdb2271", "salesChannelId": "01988451220e7308bdda1b32e87db12f", "languageIds": ["2fbb5fe2e29a4d70aa5854ce7ce3e20b"] } } } }, "responses": { "200": { "description": "Array of generated summaries", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ReviewSummaryItem" } }, { "$ref": "#/components/schemas/ReviewSummaryByLanguage" } ] }, "example": { "2fbb5fe2e29a4d70aa5854ce7ce3e20b": "Review Summary of the product in the specified language." } } } }, "400": { "description": "Bad request — validation or generation error (message returned as plain JSON string)", "content": { "application/json": { "schema": { "type": "string" }, "example": "License missing or generation failed:
" } } } } } }, "/_action/invite-employee": { "post": { "tags": ["B2B Employee Management"], "summary": "Sends an invite email to employee", "description": "This route is used to send an invite email to an employee", "operationId": "inviteEmployee", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "description": "Id of the employee to invite", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "description": "Id of the sales channel through which the registration will be fulfilled.", "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "required": ["id"], "type": "object" } } } }, "responses": { "204": { "description": "No content response" } } } }, "/_action/create-employee": { "post": { "tags": ["B2B Employee Management"], "summary": "Creates an employee", "description": "This route is used to create an employee", "operationId": "createEmployee", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "firstName": { "description": "First name of the new employee", "type": "string" }, "lastName": { "description": "Last name of the new employee", "type": "string" }, "email": { "description": "Email of the new employee", "type": "string" }, "roleId": { "description": "Id of the role of the new employee", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "IDs of the created employees", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Array of the created employee ids", "type": "array", "items": { "type": "string" } } } } } } } } } }, "/_action/update-employee": { "patch": { "tags": ["B2B Employee Management"], "summary": "Updates an employee", "description": "This route is used to update an employee", "operationId": "updateEmployee", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "id": { "description": "Id of the employee", "type": "string" }, "firstName": { "description": "First name of the employee", "type": "string" }, "lastName": { "description": "Last name of the employee", "type": "string" }, "email": { "description": "Email of the employee", "type": "string" }, "roleId": { "description": "Id of the role of the employee", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "No content response" } } } }, "/_proxy-quote/{salesChannelId}": { "post": { "tags": ["B2B Quote Management"], "summary": "Create a new quote", "description": "This route is used to create a new quote from admin", "operationId": "createQuoteFromAdmin", "parameters": [ { "name": "salesChannelId", "in": "path", "description": "Identifier of the sales channel to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "type": "object" } } } }, "responses": { "200": { "description": "Quote entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } } } } }, "/_action/quote/{quoteId}/product/{productId}": { "post": { "tags": ["B2B Quote Management"], "summary": "Add product to quote", "description": "This route is used to add a product to a quote from admin", "operationId": "addProductToQuote", "parameters": [ { "name": "quoteId", "in": "path", "description": "Identifier of the quote to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "productId", "in": "path", "description": "Identifier of the product to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "quantity": { "type": "integer", "pattern": "int32" } }, "type": "object" } } } }, "responses": { "204": { "description": "No content response" } } } }, "/_action/quote/{quoteId}/lineItem": { "post": { "tags": ["B2B Quote Management"], "summary": "Add custom line item to quote", "description": "This route is used to add a custom line item to a quote from admin", "operationId": "addCustomLineItemToQuote", "parameters": [ { "name": "quoteId", "in": "path", "description": "Identifier of the quote to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "identifier": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string", "default": "custom" }, "quantity": { "type": "integer", "pattern": "int32" }, "label": { "type": "string", "default": "null" }, "description": { "type": "string", "default": "null" }, "removable": { "type": "boolean", "default": true }, "stackable": { "type": "boolean", "default": true }, "payload": { "type": "array", "items": { "type": "object" } }, "priceDefinition": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "204": { "description": "No content response" } } } }, "/_action/quote/{quoteId}/recalculate": { "post": { "tags": ["B2B Quote Management"], "summary": "Recalculate a quote", "description": "This route is used to recalculate a quote", "operationId": "recalculateQuote", "parameters": [ { "name": "quoteId", "in": "path", "description": "Identifier of the quote to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "No content response" } } } }, "/_action/quote/{quoteId}/comment": { "post": { "tags": ["B2B Quote Management"], "summary": "Create a new comment", "description": "This route is used to create a new comment from admin", "operationId": "createComment", "parameters": [ { "name": "quoteId", "in": "path", "description": "Identifier of the quote to be fetched", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "comment": { "description": "Message content", "type": "string" }, "state": { "description": "Current quote state", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "No content response" } } } }, "/_action/text-to-image/generate": { "post": { "tags": ["Text to Image"], "summary": "Generate images based on a textual prompt", "description": "Generate images based on a textual prompt", "operationId": "textToImageGenerate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "description": "The textual prompt to describe what image to generate", "type": "string", "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" } } } } } }, "responses": { "200": { "description": "The base64 string representation of the generated image", "content": { "application/json": { "schema": { "type": "string", "format": "byte", "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" } } } } } } }, "/_action/share-config/download/{entity}/{id}": { "get": { "tags": ["Admin API", "Sharing", "Download"], "summary": "Download a shared config", "description": "This route is used to download a shared config", "operationId": "downloadSharedConfig", "parameters": [ { "name": "entity", "in": "path", "description": "Entity name of the shared config", "required": true, "schema": { "type": "string", "enum": ["flow", "rule"] } }, { "name": "id", "in": "path", "description": "Id of the shared config", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Download the shared config" }, "400": { "description": "Entity is not supported. Use flow, rule" }, "404": { "description": "Entity with id is invalid or could not be found" } } } }, "/_action/share-config/upload/{entity}": { "post": { "tags": ["Admin API", "Sharing", "Upload"], "summary": "Upload a shared config", "description": "This route is used to upload a shared config", "operationId": "uploadSharedConfig", "parameters": [ { "name": "entity", "in": "path", "description": "Entity name of the shared config", "required": true, "schema": { "type": "string", "enum": ["flow", "rule"] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Data of the shared config (Entities related that have to be included)", "type": "object" }, "references": { "description": "References of the shared config (ID's of entities that are referenced)", "type": "object" }, "requirements": { "description": "Requirements of the shared config (ID's of entities that are required)", "type": "object" }, "flow": { "description": "Flow of the shared config", "type": "object" }, "rule": { "description": "Rule of the shared config", "type": "object" } }, "required": ["data", "references", "requirements"] } } } }, "responses": { "200": { "description": "Upload the shared config" }, "400": { "description": "Entity is not supported. Use flow, rule" } } } }, "/_action/dsr/appointment/{appointmentId}/join-as-guide": { "post": { "tags": ["Appointment"], "summary": "Join a meeting as a guide", "description": "This route is used to join appointment as guide.", "operationId": "joinAppointmentAsGuide", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinAppointmentResponse" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/start": { "post": { "tags": ["Appointment"], "summary": "Start a presentation for a appointment", "description": "Complete all needed data start the presentation", "operationId": "startAppointment", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "" } } } }, "/_action/dsr/appointment/{appointmentId}/end": { "post": { "tags": ["Appointment"], "summary": "End a presentation for a appointment", "description": "Complete all needed data and remove unneeded to close the presentation", "operationId": "endAppointment", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "" } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { "get": { "tags": ["Appointment"], "summary": "Get the sw-context-token for a attendee", "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", "operationId": "getAttendeeToken", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "The sw-context-token from the attendee", "content": { "application/json": { "schema": { "type": "object", "properties": { "attendee-sw-context-token": { "type": "string" } }, "example": { "attendee-sw-context-token": "context token of attendee" } } } } } } } }, "/_action/dsr/appointment/{appointmentId}/instant-listing": { "post": { "tags": ["Appointment"], "summary": "Add a instant listing to the presentation", "description": "Add a page as the instant listing to the presentation", "operationId": "addInstantListing", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": ["productIds"], "properties": { "productIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Ids of the products which should be added to the instant listing" }, "currentPageGroupId": { "type": "string", "description": "Id of the current cms page", "pattern": "^[0-9a-f]{32}$" }, "pageName": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The name of the instant listing page" } }, "type": "object" } } } }, "responses": { "201": { "description": "Created a new instant listing", "content": { "application/json": { "schema": { "type": "object", "properties": { "index": { "type": "integer", "description": "The current index of the instant listing which is created by this request" } }, "example": { "index": 1 } } } } } } }, "patch": { "tags": ["Appointment"], "summary": "Update a instant listing from the presentation", "description": "Updates the products for the given listing", "operationId": "updateInstantListing", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "addProductIds", "removeProductIds", "currentPageGroupId" ], "properties": { "addProductIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Ids of the products which should be added to the instant listing" }, "removeProductIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Ids of the products which should be removed to the instant listing" }, "currentPageGroupId": { "type": "string", "description": "Id of the current cms page", "pattern": "^[0-9a-f]{32}$" }, "pageName": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The name of the instant listing page" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated the instant listing", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id of the instant listing page" }, "pickedProductIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Ids of the products which are picked for the instant listing" }, "title": { "type": "string", "description": "The title of the instant listing" } }, "example": { "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", "pickedProductIds": [ "018c19b80403709cb2cef54f70860042", "018c19b804027291955d8f076c272d0d" ], "title": "Default Digital Sales Rooms product listing page" } } } } } } } }, "/_action/dsr/appointment/{appointmentId}/presentation/state": { "get": { "tags": ["Appointment"], "summary": "Get the current presentation state", "description": "Returns the presentation state for all and the guide", "operationId": "getGuidePresentationState", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuidePresentationStateResponse" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/video-room": { "post": { "tags": ["Appointment"], "summary": "Create a video room", "description": "Creates a video room on the remote video tool", "operationId": "createVideoRoom", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoChatCreateStruct" } } } } } }, "delete": { "tags": ["Appointment"], "summary": "Delete a video room", "description": "Delete a video room and tokens on the remote video tool", "operationId": "deleteVideoRoom", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": [] } } } } }, "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { "get": { "tags": ["Appointment"], "summary": "Get attendee insights", "description": "Get attendee insights for the given appointment", "operationId": "getAttendeeInsights", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAttendeeInsightsResponse" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { "get": { "tags": ["Appointment"], "summary": "Get cart insights", "description": "Get cart insights for the given appointment", "operationId": "getCartInsights", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCartInsightsResponse" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { "get": { "tags": ["Appointment"], "summary": "Get cart statistics", "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", "operationId": "getCartStatistics", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "order", "in": "query", "description": "The order of the cart line items", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The sort of the cart line items", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { "get": { "tags": ["Appointment"], "summary": "Get last seen products insights", "description": "Get last seen products of all attendees for the given appointment", "operationId": "getLastSeenProductsInsights", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "limit", "in": "query", "description": "The limit of the products which should be returned", "schema": { "type": "integer", "default": 10 } }, { "name": "page", "in": "query", "description": "The page of the products which should be returned", "schema": { "type": "integer", "default": 1 } }, { "name": "term", "in": "query", "description": "The search term for the products", "schema": { "type": "string" } }, { "name": "attendeeId", "in": "query", "description": "The attendee id for which the last seen products should be returned", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetProductListing" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { "get": { "tags": ["Appointment"], "summary": "Get wishlist insights", "description": "Get wishlist of all the attendees for the given appointment", "operationId": "getWishlistInsights", "parameters": [ { "name": "appointmentId", "in": "path", "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "limit", "in": "query", "description": "The limit of the products which should be returned", "schema": { "type": "integer", "default": 10 } }, { "name": "page", "in": "query", "description": "The page of the products which should be returned", "schema": { "type": "integer", "default": 1 } }, { "name": "term", "in": "query", "description": "The search term for the wishlist products", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "The order of the wishlist products", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "The sort of the wishlist products", "schema": { "type": "string" } }, { "name": "attendeeId", "in": "query", "description": "The attendee id for which the wishlist products should be returned", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetProductListing" } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/remove": { "post": { "tags": ["Appointment"], "summary": "Remove an attendee from the appointment", "description": "Remove an attendee from the appointment", "operationId": "removeAttendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id of the removed attendee" } }, "example": { "message": "Attendee removed successfully", "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { "get": { "tags": ["Appointment"], "summary": "Get ids of last seen products", "description": "Get all product ids of that attendee has seen", "operationId": "getLastSeenProductIds", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "collection": { "type": "object", "properties": { "lastSeen": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } } } }, "example": { "collection": { "lastSeen": [ "018c19b80403709cb2cef54f70860042", "018c19b804027291955d8f076c272d0d" ] } } } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { "get": { "tags": ["Appointment"], "summary": "Load a temporary cart for the attendee", "description": "Load a temporary cart for the attendee", "operationId": "loadTempCart", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "sw-context-token", "in": "header", "description": "Contains sw-context-token value", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { "post": { "tags": ["Appointment"], "summary": "Add discount to the temp cart", "description": "Add discount to the temp cart", "operationId": "addTempDiscount", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTempDiscountRequestBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { "post": { "tags": ["Appointment"], "summary": "Remove all discount from the temp cart", "description": "Remove all discount from the temp cart", "operationId": "removeTempDiscount", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { "post": { "tags": ["Appointment"], "summary": "Apply the discount from the temp cart to the attendee cart", "description": "Apply the discount from the temp cart to the attendee cart", "operationId": "applyTempDiscount", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { "post": { "tags": ["Appointment"], "summary": "Add discount to the attendee cart", "description": "Add discount to the attendee cart", "operationId": "addCartDiscount", "parameters": [ { "name": "attendeeId", "in": "path", "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCartDiscountRequestBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart" } } } } } } }, "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { "post": { "tags": ["Appointment"], "summary": "Load line item ids of a shopping lists from the appointment", "description": "Load line item ids of a shopping lists from the appointment", "operationId": "setSharingShoppingList", "parameters": [ { "name": "appointmentId", "in": "path", "description": "The appointment id you are joining", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "name": "shoppingListId", "in": "path", "description": "The shopping list id you want to load", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "example": { "data": { "01938f89c632709ba4d65eb53604bf5b": { "quantity": "1" }, "01938f89c8647036a617b7d88e1e24f5": { "quantity": "1" }, "01938f8a23d47305b1e289163cea5074": { "quantity": "1" } } } } } } } } } }, "security": [{ "ApiKey": [] }] } }, "/_action/paypal/saleschannel-default": { "post": { "tags": ["Admin Api", "SwagPayPalPaymentMethod"], "description": "Sets PayPal as the default payment method for a given SalesChannel, or all.", "operationId": "setPayPalAsDefault", "requestBody": { "content": { "application/json": { "schema": { "properties": { "salesChannelId": { "description": "The id of the SalesChannel where PayPal should be set as the default payment method. Set to null to set PayPal as default for every Saleschannel.", "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "204": { "description": "Setting PayPal as default was successful" } } } }, "/paypal/dispute": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads a list of PayPal disputes", "operationId": "disputeList", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "query", "description": "ID of the sales channel to which the disputes belong", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "disputeStateFilter", "name": "disputeStateFilter", "in": "query", "description": "Filter for dispute state. Separate multiple states with a comma. Must one of these values: Shopware\\PayPalSDK\\Struct\\V1\\Disputes\\Item::DISPUTE_STATES", "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PayPal disputes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v1_disputes" } } } } } } }, "/paypal/dispute/{disputeId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the dispute details of the given PayPal dispute ID", "operationId": "disputeDetails", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "query", "description": "ID of the sales channel to which the disputes belong", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "disputeId", "name": "disputeId", "in": "path", "description": "ID of the dispute", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the PayPal dispute", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v1_disputes_item" } } } } } } }, "/paypal-v2/order/{orderTransactionId}/{paypalOrderId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the order details of the given PayPal order ID", "operationId": "orderDetails", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "paypalOrderId", "name": "paypalOrderId", "in": "path", "description": "ID of the PayPal order", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the PayPal order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order" } } } } } } }, "/paypal-v2/authorization/{orderTransactionId}/{authorizationId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the authorization details of the given PayPal authorization ID", "operationId": "authorizationDetails", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "authorizationId", "name": "authorizationId", "in": "path", "description": "ID of the PayPal authorization", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Details of the PayPal authorization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_authorization" } } } } } } }, "/paypal-v2/capture/{orderTransactionId}/{captureId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the capture details of the given PayPal capture ID", "operationId": "captureDetails", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "captureId", "name": "captureId", "in": "path", "description": "ID of the PayPal capture", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the PayPal capture", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture" } } } } } } }, "/paypal-v2/refund/{orderTransactionId}/{refundId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the refund details of the given PayPal refund ID", "operationId": "refundDetails", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "refundId", "name": "refundId", "in": "path", "description": "ID of the PayPal refund", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the PayPal refund", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_refund" } } } } } } }, "/_action/paypal-v2/refund-capture/{orderTransactionId}/{captureId}/{paypalOrderId}": { "post": { "tags": ["Admin API", "PayPal"], "description": "Refunds the PayPal capture and sets the state of the Shopware order transaction accordingly", "operationId": "refundCapture", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "captureId", "name": "captureId", "in": "path", "description": "ID of the PayPal capture", "required": true, "schema": { "type": "string" } }, { "parameter": "paypalOrderId", "name": "paypalOrderId", "in": "path", "description": "ID of the PayPal order", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "partnerAttributionId": { "description": "Partner Attribution ID. See Swag\\PayPal\\RestApi\\PartnerAttributionId", "type": "string" }, "amount": { "description": "Amount which should be refunded", "type": "string" }, "currency": { "description": "Currency of the refund", "type": "string" }, "invoiceNumber": { "description": "Invoice number of the refund", "type": "string" }, "noteToPayer": { "description": "A note to the payer sent with the refund", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Details of the PayPal refund", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_refund" } } } } } } }, "/_action/paypal-v2/capture-authorization/{orderTransactionId}/{authorizationId}": { "post": { "tags": ["Admin API", "PayPal"], "description": "Captures the PayPal authorization and sets the state of the Shopware order transaction accordingly", "operationId": "captureAuthorization", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "authorizationId", "name": "authorizationId", "in": "path", "description": "ID of the PayPal authorization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "partnerAttributionId": { "description": "Partner Attribution ID. See Swag\\PayPal\\RestApi\\PartnerAttributionId", "type": "string" }, "amount": { "description": "Amount which should be captured", "type": "string" }, "currency": { "description": "Currency of the capture", "type": "string" }, "invoiceNumber": { "description": "Invoice number of the capture", "type": "string" }, "noteToPayer": { "description": "A note to the payer sent with the capture", "type": "string" }, "isFinal": { "description": "Define if this is the final capture", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Details of the PayPal capture", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture" } } } } } } }, "/_action/paypal-v2/void-authorization/{orderTransactionId}/{authorizationId}": { "post": { "tags": ["Admin API", "PayPal"], "description": "Voids the PayPal authorization and sets the state of the Shopware order transaction accordingly", "operationId": "voidAuthorization", "parameters": [ { "parameter": "orderTransactionId", "name": "orderTransactionId", "in": "path", "description": "ID of the order transaction which contains the PayPal payment", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "authorizationId", "name": "authorizationId", "in": "path", "description": "ID of the PayPal authorization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "partnerAttributionId": { "description": "Partner Attribution ID. See Swag\\PayPal\\RestApi\\PartnerAttributionId", "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "Avoidance was successful" } } } }, "/paypal/payment-details/{orderId}/{paymentId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the Payment details of the given PayPal ID", "operationId": "paymentDetails", "parameters": [ { "parameter": "orderId", "name": "orderId", "in": "path", "description": "ID of the order which contains the PayPal payment", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "paymentId", "name": "paymentId", "in": "path", "description": "ID of the PayPal payment", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Details of the PayPal payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v1_payment" } } } } } } }, "/paypal/resource-details/{resourceType}/{resourceId}/{orderId}": { "get": { "tags": ["Admin API", "PayPal"], "description": "Loads the PayPal resource details of the given resource ID", "operationId": "resourceDetails", "parameters": [ { "parameter": "resourceType", "name": "resourceType", "in": "path", "description": "Type of the resource. Possible values: sale, authorization, order, capture, refund", "schema": { "type": "string", "enum": ["sale", "authorize", "order", "capture"] } }, { "parameter": "resourceId", "name": "resourceId", "in": "path", "description": "ID of the PayPal resource", "schema": { "type": "string" } }, { "parameter": "orderId", "name": "orderId", "in": "path", "description": "ID of the order which contains the PayPal resource", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Details of the PayPal resource", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_sale" }, { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_authorization" }, { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_order" }, { "$ref": "#/components/schemas/paypal_v1_capture" } ] } } } } } } }, "/_action/paypal/pos/sync/{salesChannelId}/products": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncProducts", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Run ID of the started sync process", "content": { "application/json": { "schema": { "properties": { "runId": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/pos/sync/{salesChannelId}/images": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncImages", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Run ID of the started sync process", "content": { "application/json": { "schema": { "properties": { "runId": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/pos/sync/{salesChannelId}/inventory": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncInventory", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Run ID of the started sync process", "content": { "application/json": { "schema": { "properties": { "runId": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/pos/sync/{salesChannelId}": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSync", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Run ID of the started sync process", "content": { "application/json": { "schema": { "properties": { "runId": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/pos/sync/abort/{runId}": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncAbort", "parameters": [ { "parameter": "runId", "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Abortion was successful" } } } }, "/_action/paypal/pos/sync/reset/{salesChannelId}": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncReset", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Reset was successful" } } } }, "/_action/paypal/pos/log/cleanup/{salesChannelId}": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posSyncCleanup", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Cleanup was successful" } } } }, "/paypal/pos/product-log/{salesChannelId}": { "get": { "tags": ["Admin Api", "PayPal"], "operationId": "posProductLog", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "limit", "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1 } }, { "parameter": "page", "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "Product log of the sales channel" } } } }, "/_action/paypal/pos/validate-api-credentials": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posValidateApiCredentials", "requestBody": { "content": { "application/json": { "schema": { "properties": { "apiKey": { "type": "string" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "type": "object" } } } }, "responses": { "200": { "description": "Validation result of the API credentials", "content": { "application/json": { "schema": { "properties": { "credentialsValid": { "type": "boolean" } }, "type": "object" } } } } } } }, "/paypal/pos/fetch-information": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posFetchInformation", "requestBody": { "content": { "application/json": { "schema": { "properties": { "apiKey": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Fetched information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swag_paypal_pos_setting_additional_information" } } } } } } }, "/_action/paypal/pos/clone-product-visibility": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "posCloneProductVisibility", "requestBody": { "content": { "application/json": { "schema": { "properties": { "fromSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "type": "object" } } } }, "responses": { "204": { "description": "Cloning of product visibility was successful" } } } }, "/paypal/pos/product-count": { "get": { "tags": ["Admin Api", "PayPal"], "operationId": "posGetProductCounts", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "parameter": "cloneSalesChannelId", "name": "cloneSalesChannelId", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Product counts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swag_paypal_pos_setting_product_count" } } } } } } }, "/_action/paypal/pos/webhook/registration/{salesChannelId}": { "post": { "tags": ["Admin Api", "SwagPayPalPosWebhook"], "operationId": "registerPosWebhook", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Webhook registration was successful" } } }, "delete": { "tags": ["Admin Api", "SwagPayPalPosWebhook"], "operationId": "deregisterPosWebhook", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "204": { "description": "Webhook deregistration was successful" } } } }, "/_action/paypal/pos/webhook/execute/{salesChannelId}": { "post": { "tags": ["Admin Api", "SwagPayPalPosWebhook"], "operationId": "executePosWebhook", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swag_paypal_pos_webhook" } } } }, "responses": { "204": { "description": "Webhook execution was successful" } } } }, "/_action/paypal/test-api-credentials": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "testApiCredentials", "responses": { "200": { "description": "Returns if the provided API credentials are valid", "content": { "application/json": { "schema": { "required": ["valid", "errors"], "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/error" } } }, "type": "object" } } } } } } }, "/_action/paypal/get-api-credentials": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "getApiCredentials", "requestBody": { "content": { "application/json": { "schema": { "properties": { "authCode": { "type": "string" }, "sharedId": { "type": "string" }, "nonce": { "type": "string" }, "sandboxActive": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns the API credentials", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } }, "/_action/paypal/merchant-information": { "get": { "tags": ["Admin Api", "PayPal"], "operationId": "getMerchantInformation", "parameters": [ { "name": "salesChannelId", "in": "query", "description": "The id of the sales channel to get merchant information for", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Returns information about the merchant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/swag_paypal_setting_merchant_information" } } } } } } }, "/_action/paypal/save-settings": { "post": { "tags": ["Admin Api", "PayPal"], "operationId": "saveSettings", "responses": { "200": { "description": "Returns information about the saved settings", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/swag_paypal_setting_settings_information" } } } } } } } }, "/_action/paypal/webhook/status/{salesChannelId}": { "get": { "tags": ["Admin Api", "SwagPayPalWebhook"], "operationId": "getWebhookStatus", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Returns the status of the PayPal webhook", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/webhook/register/{salesChannelId}": { "post": { "tags": ["Admin Api", "SwagPayPalWebhook"], "operationId": "registerWebhook", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Returns the action taken for the webhook registration", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/webhook/deregister/{salesChannelId}": { "delete": { "tags": ["Admin Api", "SwagPayPalWebhook"], "operationId": "deregisterWebhook", "parameters": [ { "parameter": "salesChannelId", "name": "salesChannelId", "in": "path", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { "description": "Returns the action taken for the webhook deregistration", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string" } }, "type": "object" } } } } } } }, "/_action/paypal/webhook/execute": { "post": { "tags": ["Admin Api", "SwagPayPalPosWebhook"], "operationId": "executeWebhook", "parameters": [ { "parameter": "sw-token", "name": "sw-token", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paypal_v1_webhook_event" } } } }, "responses": { "204": { "description": "Webhook execution was successful" } } } } }, "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": "array", "items": { "properties": { "parameters": { "type": "array", "items": { "type": "mixed" } } }, "type": "object" } } }, "type": "object", "additionalProperties": false, "required": ["code", "status", "title", "detail", "meta"] }, "AclRoleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "users": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/users" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "example": "9bc65c2abec141778ffaa729489f3e87" } } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "integrations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "example": "415320131958c70f4f250ca4d7e63bbd" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AclRole": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "app": { "$ref": "#/components/schemas/App" }, "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } } }, "type": "object" }, "AclUserRole": { "description": "Added since version: 6.0.0.0", "required": ["userId", "aclRoleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" }, "aclRole": { "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, "AdvancedSearchActionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "configId", "type", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "type": { "type": "string" }, "name": { "type": "string" }, "typeConfig": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "searchTerms": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_action_search_term" }, "id": { "type": "string", "example": "952c07f523c564f09844ca7f880c2467" } } } } }, "type": "object" }, "config": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2245023265ae4cf87d02c8b6ba991139" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchAction": { "required": ["id", "configId", "type", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "type": { "type": "string" }, "name": { "type": "string" }, "typeConfig": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "searchTerms": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" } }, "config": { "$ref": "#/components/schemas/AdvancedSearchConfig" } }, "type": "object" }, "AdvancedSearchActionSearchTermJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "term", "salesChannelId", "actionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "term": { "type": "string" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "action": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "418c5509e2171d55b0aee5c2ea4442b5" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchActionSearchTerm": { "required": ["id", "term", "salesChannelId", "actionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "term": { "type": "string" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "action": { "$ref": "#/components/schemas/AdvancedSearchAction" } }, "type": "object" }, "AdvancedSearchBoostingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "boost", "name", "configId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time" }, "boost": { "type": "number", "format": "float" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "entityStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_entity_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62acf68da615789a0175ef827f74acbb" } } } }, "type": "object" }, "config": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2245023265ae4cf87d02c8b6ba991139" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchBoosting": { "required": ["id", "boost", "name", "configId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time" }, "boost": { "type": "number", "format": "float" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "entityStream": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" }, "config": { "$ref": "#/components/schemas/AdvancedSearchConfig" } }, "type": "object" }, "AdvancedSearchConfigJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "esEnabled": { "type": "boolean" }, "andLogic": { "type": "boolean" }, "minSearchLength": { "type": "integer", "format": "int64" }, "hitCount": { "properties": { "product": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "product_manufacturer": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "category": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "fields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_config_field" }, "id": { "type": "string", "example": "d05b6ed7d2345020440df396d6da7f73" } } } } }, "type": "object" }, "boostings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_boosting" }, "id": { "type": "string", "example": "8e571802e4ea39b214104ca60e13b5a6" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchConfig": { "required": ["id", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "esEnabled": { "type": "boolean" }, "andLogic": { "type": "boolean" }, "minSearchLength": { "type": "integer", "format": "int64" }, "hitCount": { "properties": { "product": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "product_manufacturer": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" }, "category": { "properties": { "maxSuggestCount": { "type": "integer", "format": "int64" }, "maxSearchCount": { "type": "integer", "format": "int64" } }, "type": "object" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchConfigField" } }, "boostings": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } } }, "type": "object" }, "AdvancedSearchConfigFieldJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "configId", "entity", "field"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "field": { "type": "string" }, "tokenize": { "type": "boolean" }, "searchable": { "type": "boolean" }, "ranking": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "config": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2245023265ae4cf87d02c8b6ba991139" } } } }, "type": "object" }, "customField": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ed2028a1c479c7e0065da597452d9c11" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchConfigField": { "required": ["id", "configId", "entity", "field"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "field": { "type": "string" }, "tokenize": { "type": "boolean" }, "searchable": { "type": "boolean" }, "ranking": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "config": { "$ref": "#/components/schemas/AdvancedSearchConfig" }, "customField": { "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, "AdvancedSearchEntityStreamJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "apiFilter": { "type": "object", "readOnly": true }, "invalid": { "type": "boolean", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "filters": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_entity_stream_filter" }, "id": { "type": "string", "example": "2c9885d2b0c7e26971f60a90f33cf718" } } } } }, "type": "object" }, "boosting": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_boosting" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6ab105abdd48ced24ce7b0e516ca0970" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchEntityStream": { "required": ["id", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "apiFilter": { "type": "object", "readOnly": true }, "invalid": { "type": "boolean", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } }, "boosting": { "$ref": "#/components/schemas/AdvancedSearchBoosting" } }, "type": "object" }, "AdvancedSearchEntityStreamFilterJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "entityStreamId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "parameters": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "entityStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_entity_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62acf68da615789a0175ef827f74acbb" } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_entity_stream_filter" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "queries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "advanced_search_entity_stream_filter" }, "id": { "type": "string", "example": "5da7eb4247add5dbd5776c9c0b38460a" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchEntityStreamFilter": { "required": ["id", "entityStreamId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "parameters": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "entityStream": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" }, "parent": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } } }, "type": "object" }, "AdvancedSearchSynonymJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "left"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "left": { "type": "array", "items": { "type": "string" } }, "right": { "type": "array", "items": { "type": "string" } }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AdvancedSearchSynonym": { "required": ["id", "left"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "left": { "type": "array", "items": { "type": "string" } }, "right": { "type": "array", "items": { "type": "string" } }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "AppJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "path", "version", "integrationId", "aclRoleId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "path": { "type": "string" }, "author": { "type": "string" }, "copyright": { "type": "string" }, "license": { "type": "string" }, "active": { "type": "boolean" }, "configurable": { "type": "boolean" }, "privacy": { "type": "string" }, "version": { "type": "string" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "modules": { "type": "array", "items": { "type": "object" } }, "mainModule": { "type": "object" }, "cookies": { "type": "array", "items": { "type": "object" } }, "allowDisable": { "type": "boolean" }, "baseAppUrl": { "type": "string" }, "allowedHosts": { "type": "array", "items": { "type": "string" } }, "templateLoadPriority": { "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "storefrontConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/storefrontConfig" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "saas_app_storefront_config" }, "id": { "type": "string", "example": "bd1f4963443684177aac2b302cded7ac" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "integration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "776ea3bf11df5829827f7afb43c37174" } } } }, "type": "object" }, "aclRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "acl_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "250aa1c64b973365fd6fd489eefbdefc" } } } }, "type": "object" }, "customFieldSets": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "example": "9b29ba872ce510f033b31364c8602760" } } } } }, "type": "object" }, "actionButtons": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_action_button" }, "id": { "type": "string", "example": "2c7967427ed432e546ef1c0cb8d5da9e" } } } } }, "type": "object" }, "templates": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_template" }, "id": { "type": "string", "example": "fed36e93a0509e20f2dc96cbbd85b678" } } } } }, "type": "object" }, "webhooks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "webhook" }, "id": { "type": "string", "example": "c10f40999b74c408263f790b30e70efe" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "taxProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_provider" }, "id": { "type": "string", "example": "01a1a9d428b6402dc8255d99c787a00e" } } } } }, "type": "object" }, "cmsBlocks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_cms_block" }, "id": { "type": "string", "example": "3636c4901eab836dfb837e1a9a37d3c0" } } } } }, "type": "object" }, "flowActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_action" }, "id": { "type": "string", "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" } } } } }, "type": "object" }, "flowEvents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_event" }, "id": { "type": "string", "example": "045e9ec14eafd26d17854fb4fe7c9cae" } } } } }, "type": "object" }, "appShippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "app_shipping_method" }, "id": { "type": "string", "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "App": { "description": "Added since version: 6.3.1.0", "required": [ "id", "name", "path", "version", "integrationId", "aclRoleId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "path": { "type": "string" }, "author": { "type": "string" }, "copyright": { "type": "string" }, "license": { "type": "string" }, "active": { "type": "boolean" }, "configurable": { "type": "boolean" }, "privacy": { "type": "string" }, "version": { "type": "string" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "modules": { "type": "array", "items": { "type": "object" } }, "mainModule": { "type": "object" }, "cookies": { "type": "array", "items": { "type": "object" } }, "allowDisable": { "type": "boolean" }, "baseAppUrl": { "type": "string" }, "allowedHosts": { "type": "array", "items": { "type": "string" } }, "templateLoadPriority": { "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "storefrontConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app/ac863f346e618f9a959b5c95d5d28941/storefrontConfig" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "saas_app_storefront_config" }, "id": { "type": "string", "example": "bd1f4963443684177aac2b302cded7ac" } } } } }, "type": "object" } }, "type": "object" }, "integration": { "$ref": "#/components/schemas/Integration" }, "aclRole": { "$ref": "#/components/schemas/AclRole" }, "customFieldSets": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSet" } }, "actionButtons": { "type": "array", "items": { "$ref": "#/components/schemas/AppActionButton" } }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/AppTemplate" } }, "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "taxProviders": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } }, "cmsBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/AppCmsBlock" } }, "flowActions": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowAction" } }, "flowEvents": { "type": "array", "items": { "$ref": "#/components/schemas/AppFlowEvent" } }, "appShippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } }, "type": "object" }, "AppActionButtonJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "entity", "view", "url", "action", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "view": { "type": "string" }, "url": { "type": "string" }, "action": { "type": "string" }, "label": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": ["id", "entity", "view", "url", "action", "appId", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "view": { "type": "string" }, "url": { "type": "string" }, "action": { "type": "string" }, "label": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppAdministrationSnippetJsonApi": { "description": "Added since version: 6.4.15.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "value", "appId", "localeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "AppAdministrationSnippet": { "description": "Added since version: 6.4.15.0", "required": ["id", "value", "appId", "localeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "AppCmsBlockJsonApi": { "description": "Added since version: 6.4.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "block", "template", "styles", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "block": { "type": "object" }, "template": { "type": "string" }, "styles": { "type": "string" }, "label": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ "id", "name", "block", "template", "styles", "appId", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "block": { "type": "object" }, "template": { "type": "string" }, "styles": { "type": "string" }, "label": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "AppFlowActionJsonApi": { "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appId", "name", "url", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "badge": { "type": "string" }, "parameters": { "type": "object" }, "config": { "type": "object" }, "headers": { "type": "object" }, "requirements": { "type": "array", "items": { "type": "string" } }, "iconRaw": { "type": "string" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "swIcon": { "type": "string" }, "url": { "type": "string" }, "delayable": { "type": "boolean" }, "label": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": ["id", "appId", "name", "url", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "badge": { "type": "string" }, "parameters": { "type": "object" }, "config": { "type": "object" }, "headers": { "type": "object" }, "requirements": { "type": "array", "items": { "type": "string" } }, "iconRaw": { "type": "string" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "swIcon": { "type": "string" }, "url": { "type": "string" }, "delayable": { "type": "boolean" }, "label": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" }, "flowSequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } } }, "type": "object" }, "AppFlowEventJsonApi": { "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appId", "name", "aware"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "aware": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "flows": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "id": { "type": "string", "example": "0db2dd944f9ee9a131f44b79d331d371" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppFlowEvent": { "description": "Added since version: 6.5.2.0", "required": ["id", "appId", "name", "aware"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "aware": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "flows": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } }, "type": "object" }, "AppPaymentMethodJsonApi": { "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appName", "identifier", "paymentMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "payUrl": { "type": "string" }, "finalizeUrl": { "type": "string" }, "validateUrl": { "type": "string" }, "captureUrl": { "type": "string" }, "refundUrl": { "type": "string" }, "recurringUrl": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "originalMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", "required": ["id", "appName", "identifier", "paymentMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "payUrl": { "type": "string" }, "finalizeUrl": { "type": "string" }, "validateUrl": { "type": "string" }, "captureUrl": { "type": "string" }, "refundUrl": { "type": "string" }, "recurringUrl": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "originalMedia": { "$ref": "#/components/schemas/Media" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "AppScriptConditionJsonApi": { "description": "Added since version: 6.4.10.3", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "identifier", "active", "appId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "group": { "type": "string" }, "script": { "type": "string" }, "config": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "ruleConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "24bfabce4195894c9aed9b8bcfb0b748" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": ["id", "identifier", "active", "appId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "group": { "type": "string" }, "script": { "type": "string" }, "config": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" }, "ruleConditions": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, "AppShippingMethodJsonApi": { "description": "Added since version: 6.5.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appName", "identifier", "shippingMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "originalMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppShippingMethod": { "description": "Added since version: 6.5.7.0", "required": ["id", "appName", "identifier", "shippingMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "identifier": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "originalMedia": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "AppTemplateJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "template", "path", "active", "appId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "template": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "AppTemplate": { "description": "Added since version: 6.3.1.0", "required": ["id", "template", "path", "active", "appId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "template": { "type": "string" }, "path": { "type": "string" }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "B2bBusinessPartnerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "defaultRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2944ea414640901d532eba5106eb706b" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bBusinessPartner": { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "defaultRole": { "$ref": "#/components/schemas/B2bComponentsRole" } }, "type": "object" }, "B2bComponentsAdvancedProductCatalogsJsonApi": { "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customerId", "organizationId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoAddNewCategories": { "type": "boolean" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "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": { "customerGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customerGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannels" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "986f6f891e90ab91c091ff4a1a460777" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "advancedProductCatalogsCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/advancedProductCatalogsCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", "example": "0a628ceb24e0f626e3355b2ffac1c2f7" } } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsAdvancedProductCatalogs": { "description": "Added since version: 6.7.1.0", "required": ["id", "customerId", "organizationId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoAddNewCategories": { "type": "boolean" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "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 }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "customer": { "$ref": "#/components/schemas/Customer" }, "organization": { "$ref": "#/components/schemas/B2bComponentsOrganization" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "salesChannels": { "$ref": "#/components/schemas/SalesChannel" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "advancedProductCatalogsCategories": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogsCategory" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "type": "object" }, "B2bComponentsAdvancedProductCatalogsCategory": { "required": ["advancedProductCatalogsId", "categoryId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "advancedProductCatalogsId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "advancedProductCatalog": { "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" }, "category": { "$ref": "#/components/schemas/Category" } }, "type": "object" }, "B2bComponentsApprovalRuleJsonApi": { "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "priority", "active", "conditions"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "conditions": { "type": "object" }, "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "businessPartnerCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" }, "reviewerRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06ec286ee4d03afb4028caa32c0ef40b" } } } }, "type": "object" }, "affectedRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "33237c6057eedd7b8c978f77270af3b1" } } } }, "type": "object" }, "pendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "2a7cfaa402d9b52e7ecd072ae390d84b" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsApprovalRule": { "description": "Added since version: 6.6.0.0", "required": ["id", "name", "priority", "active", "conditions"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "conditions": { "type": "object" }, "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "businessPartnerCustomer": { "$ref": "#/components/schemas/Customer" }, "reviewerRole": { "$ref": "#/components/schemas/B2bComponentsRole" }, "affectedRole": { "$ref": "#/components/schemas/B2bComponentsRole" }, "pendingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } }, "type": "object" }, "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { "description": "Added since version: 6.6.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "identifier", "active", "appId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "group": { "type": "string" }, "script": { "type": "string" }, "config": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsApprovalRuleAppScriptCondition": { "description": "Added since version: 6.6.3.0", "required": ["id", "identifier", "active", "appId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "group": { "type": "string" }, "script": { "type": "string" }, "config": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "B2bComponentsBudgetJsonApi": { "description": "Added since version: 6.7.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "technicalName", "amount", "startDate", "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "costCentre": { "type": "string" }, "technicalName": { "type": "string" }, "active": { "type": "boolean" }, "amount": { "type": "number", "format": "float" }, "usedAmount": { "type": "number", "format": "float", "readOnly": true }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "renewsType": { "type": "string" }, "lastRenews": { "type": "string", "readOnly": true }, "nextRenews": { "type": "string", "readOnly": true }, "allowApproval": { "type": "boolean" }, "showRemaining": { "type": "boolean" }, "notify": { "type": "boolean" }, "notificationConfig": { "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "sent": { "type": "boolean", "readOnly": true }, "customFields": { "type": "object" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "organizations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/organizations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "d9811f03b461a380c0d6b4a497dbac37" } } } } }, "type": "object" }, "notificationRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/notificationRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "bd4a2b3045182246fac51c0abc10c4d7" } } } } }, "type": "object" }, "reviewerRole": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/reviewerRole" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06ec286ee4d03afb4028caa32c0ef40b" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsBudget": { "description": "Added since version: 6.7.4.0", "required": [ "id", "name", "technicalName", "amount", "startDate", "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "costCentre": { "type": "string" }, "technicalName": { "type": "string" }, "active": { "type": "boolean" }, "amount": { "type": "number", "format": "float" }, "usedAmount": { "type": "number", "format": "float", "readOnly": true }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "renewsType": { "type": "string" }, "lastRenews": { "type": "string", "readOnly": true }, "nextRenews": { "type": "string", "readOnly": true }, "allowApproval": { "type": "boolean" }, "showRemaining": { "type": "boolean" }, "notify": { "type": "boolean" }, "notificationConfig": { "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "sent": { "type": "boolean", "readOnly": true }, "customFields": { "type": "object" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "createdBy": { "$ref": "#/components/schemas/User" }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganization" } }, "notificationRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } }, "reviewerRole": { "$ref": "#/components/schemas/B2bComponentsRole" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "B2bComponentsBudgetNotificationRecipient": { "description": "Added since version: 6.7.4.0", "required": ["budgetId", "employeeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "budgetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "budget": { "$ref": "#/components/schemas/B2bComponentsBudget" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, "B2bComponentsBudgetOrganization": { "description": "Added since version: 6.7.4.0", "required": ["budgetId", "organizationId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "budgetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "budget": { "$ref": "#/components/schemas/B2bComponentsBudget" }, "organization": { "$ref": "#/components/schemas/B2bComponentsOrganization" } }, "type": "object" }, "B2bComponentsEmployeeWishlistJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "employeeId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsEmployeeWishlist": { "required": ["id", "employeeId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } }, "type": "object" }, "B2bComponentsEmployeeWishlistProductJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "employeeWishlistId", "productId", "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeWishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "employeeWishlist": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/employeeWishlist" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_employee_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "396edf0709663088597d101284333942" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsEmployeeWishlistProduct": { "required": [ "id", "employeeWishlistId", "productId", "productVersionId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeWishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "employeeWishlist": { "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "B2bComponentsOrganizationJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "customerId", "defaultShippingAddressId", "defaultBillingAddressId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "employees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/employees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } } }, "type": "object" }, "organizationCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/organizationCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", "example": "ada6a19a929bea8dbec29edb3d68df58" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "defaultShippingAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultShippingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8218c377171d06883caea7e2baf67f31" } } } }, "type": "object" }, "defaultBillingAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultBillingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsOrganization": { "required": [ "id", "name", "customerId", "defaultShippingAddressId", "defaultBillingAddressId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" } }, "type": "object" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } }, "organizationCustomerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "B2bComponentsOrganizationCustomerAddressJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "organizationId", "customerAddressId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customerAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-organization-customer-address/01f4816d6912a00b6c3f7cfd02672e16/customerAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ede14a49881da866970ac311e0ac78f8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsOrganizationCustomerAddress": { "required": ["id", "organizationId", "customerAddressId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customerAddress": { "$ref": "#/components/schemas/CustomerAddress" } }, "type": "object" }, "B2bComponentsOrganizationPaymentMethod": { "required": ["b2bComponentsOrganizationId", "paymentMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "b2bComponentsOrganizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "b2bComponentsOrganization": { "$ref": "#/components/schemas/B2bComponentsOrganization" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "B2bComponentsOrganizationShippingMethod": { "required": ["b2bComponentsOrganizationId", "shippingMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "b2bComponentsOrganizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "b2bComponentsOrganization": { "$ref": "#/components/schemas/B2bComponentsOrganization" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" } }, "type": "object" }, "B2bComponentsPendingOrderJsonApi": { "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "billingAddressId", "customerId", "employeeId", "stateId", "currencyId", "countryId", "salesChannelId", "shippingMethodId", "paymentMethodId", "languageId", "number", "cartPayload", "itemRounding", "totalRounding", "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "decidedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "approvalRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "number": { "type": "string" }, "cartPayload": { "type": "string" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "originalPrice": { "type": "number", "format": "float" }, "taxStatus": { "type": "string", "readOnly": true }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "reason": { "type": "string" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "lineItemCount": { "type": "integer", "format": "int64" }, "designatedPayerIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "budget": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2f212049ce79d2b949fd242043004288" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "billingAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, "decidedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b293e6616bcffea8e393a4066a4a4230" } } } }, "type": "object" }, "approvalRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" } } } }, "type": "object" }, "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "addresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "963e3a2fe559e393bad631f3dc686f69" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsPendingOrder": { "description": "Added since version: 6.6.0.0", "required": [ "id", "billingAddressId", "customerId", "employeeId", "stateId", "currencyId", "countryId", "salesChannelId", "shippingMethodId", "paymentMethodId", "languageId", "number", "cartPayload", "itemRounding", "totalRounding", "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "decidedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "approvalRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "number": { "type": "string" }, "cartPayload": { "type": "string" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "originalPrice": { "type": "number", "format": "float" }, "taxStatus": { "type": "string", "readOnly": true }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "reason": { "type": "string" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "lineItemCount": { "type": "integer", "format": "int64" }, "designatedPayerIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "budget": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2f212049ce79d2b949fd242043004288" } } } }, "type": "object" } }, "type": "object" }, "order": { "$ref": "#/components/schemas/Order" }, "billingAddress": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "decidedBy": { "$ref": "#/components/schemas/B2bEmployee" }, "approvalRule": { "$ref": "#/components/schemas/B2bComponentsApprovalRule" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "country": { "$ref": "#/components/schemas/Country" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } }, "type": "object" }, "B2bComponentsPendingOrderAddressJsonApi": { "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "countryId", "pendingOrderId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pendingOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/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": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, "pendingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1fd94955ea55110a2cf95eeb6fb1679f" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, "billingAddressPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/billingAddressPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "b4e47f63a7c39869d14bf20e25a45489" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsPendingOrderAddress": { "description": "Added since version: 6.6.0.0", "required": [ "id", "countryId", "pendingOrderId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pendingOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "pendingOrder": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "salutation": { "$ref": "#/components/schemas/Salutation" }, "billingAddressPendingOrders": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } }, "type": "object" }, "B2bComponentsRoleJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "default": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "b2bBusinessPartner": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, "b2bReviewerApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "25fd4841a35dd38cba144c6a480b52bb" } } } } }, "type": "object" }, "b2bAffectedApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "844042c07d902b98a574a2e21845c1e6" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "employees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } } }, "type": "object" }, "businessPartnerCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsRole": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "default": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "b2bBusinessPartner": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, "b2bReviewerApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "25fd4841a35dd38cba144c6a480b52bb" } } } } }, "type": "object" }, "b2bAffectedApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "844042c07d902b98a574a2e21845c1e6" } } } } }, "type": "object" } }, "type": "object" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/B2bEmployee" } }, "businessPartnerCustomer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "B2bComponentsShoppingListJsonApi": { "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salesChannelId", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, "lineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsShoppingList": { "description": "Added since version: 6.6.2.0", "required": ["id", "salesChannelId", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } }, "type": "object" }, "B2bComponentsShoppingListLineItemJsonApi": { "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "quantity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "shoppingList": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "75cf6f56c85d6cbfe36939709500418b" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bComponentsShoppingListLineItem": { "description": "Added since version: 6.6.2.0", "required": ["id", "quantity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "shoppingList": { "$ref": "#/components/schemas/B2bComponentsShoppingList" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "B2bEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "languageId", "firstName", "lastName", "email"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "roleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "recoveryTime": { "type": "string", "format": "date-time" }, "customFields": { "type": "object" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_employee" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, "b2bOrderEmployees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_order_employee" }, "id": { "type": "string", "example": "6d4a2ca331b1f28767d02f210af4ac7b" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bDecidedPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "c231abdb725547458353efbf48c35d43" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "businessPartnerCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/businessPartnerCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" }, "role": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/role" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "29a7e96467b69a9f5a93332e29e9b0de" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bEmployee": { "required": ["id", "languageId", "firstName", "lastName", "email"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "roleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "recoveryTime": { "type": "string", "format": "date-time" }, "customFields": { "type": "object" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_employee" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, "b2bOrderEmployees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_order_employee" }, "id": { "type": "string", "example": "6d4a2ca331b1f28767d02f210af4ac7b" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bDecidedPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "c231abdb725547458353efbf48c35d43" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" } }, "type": "object" }, "businessPartnerCustomer": { "$ref": "#/components/schemas/Customer" }, "role": { "$ref": "#/components/schemas/B2bComponentsRole" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "B2bOrderEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderId", "firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "B2bOrderEmployee": { "required": ["id", "orderId", "firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, "B2bPermissionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "group"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "group": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "B2bPermission": { "required": ["id", "name", "group"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "group": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "CategoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { "type": "boolean" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "breadcrumb": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "level": { "type": "integer", "format": "int64", "readOnly": true }, "path": { "type": "string", "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "type": { "type": "string" }, "productAssignmentType": { "type": "string" }, "visible": { "type": "boolean" }, "active": { "type": "boolean" }, "cmsPageIdSwitched": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "visibleChildCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "linkType": { "type": "string" }, "internalLink": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalLink": { "type": "string" }, "linkNewTab": { "type": "boolean" }, "description": { "type": "string" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "keywords": { "type": "string" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "search": { "type": "object" }, "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" }, "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" }, "advancedProductCatalogsCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", "example": "0a628ceb24e0f626e3355b2ffac1c2f7" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "parent": { "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { "type": "boolean" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "breadcrumb": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "level": { "type": "integer", "format": "int64", "readOnly": true }, "path": { "type": "string", "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "type": { "type": "string" }, "productAssignmentType": { "type": "string" }, "visible": { "type": "boolean" }, "active": { "type": "boolean" }, "cmsPageIdSwitched": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "visibleChildCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "linkType": { "type": "string" }, "internalLink": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalLink": { "type": "string" }, "linkNewTab": { "type": "boolean" }, "description": { "type": "string" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "keywords": { "type": "string" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customEntityTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "search": { "type": "object" }, "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" }, "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" }, "advancedProductCatalogsCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs_category" }, "id": { "type": "string", "example": "0a628ceb24e0f626e3355b2ffac1c2f7" } } } } }, "type": "object" } }, "type": "object" }, "parent": { "$ref": "#/components/schemas/Category" }, "children": { "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { "$ref": "#/components/schemas/Media", "description": "Category image or banner" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "nestedProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "tags": { "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { "$ref": "#/components/schemas/CmsPage", "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "navigationSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "footerSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "serviceSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "mainCategories": { "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "seoUrls": { "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } }, "type": "object" }, "CategoryTag": { "description": "Added since version: 6.0.0.0", "required": ["categoryId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "category": { "$ref": "#/components/schemas/Category" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "CeSpatialPreviewJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "previewId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/ce-spatial-preview/f72ce57f3fa91cfc7ed1e5ea84f4560b/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "preview": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/ce-spatial-preview/f72ce57f3fa91cfc7ed1e5ea84f4560b/preview" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5ebeb6065f64f2346dbb00ab789cf001" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CeSpatialPreview": { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "previewId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "media": { "$ref": "#/components/schemas/Media" }, "preview": { "$ref": "#/components/schemas/Media" } }, "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": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "sectionPosition": { "type": "string" }, "marginTop": { "type": "string" }, "marginBottom": { "type": "string" }, "marginLeft": { "type": "string" }, "marginRight": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { "type": "string" }, "cssClass": { "type": "string" }, "visibility": { "properties": { "mobile": { "type": "boolean" }, "desktop": { "type": "boolean" }, "tablet": { "type": "boolean" } }, "type": "object" }, "sectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "swagCmsExtensionsQuickview": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/swagCmsExtensionsQuickview" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_quickview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fae098a43df8714eda5249176ffcf26c" } } } }, "type": "object" }, "swagCmsExtensionsBlockRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/swagCmsExtensionsBlockRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_block_rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c426e9e5d9031b933f89682d49bb02b1" } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "sectionPosition": { "type": "string" }, "marginTop": { "type": "string" }, "marginBottom": { "type": "string" }, "marginLeft": { "type": "string" }, "marginRight": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { "type": "string" }, "cssClass": { "type": "string" }, "visibility": { "properties": { "mobile": { "type": "boolean" }, "desktop": { "type": "boolean" }, "tablet": { "type": "boolean" } }, "type": "object" }, "sectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "swagCmsExtensionsQuickview": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/swagCmsExtensionsQuickview" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_quickview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fae098a43df8714eda5249176ffcf26c" } } } }, "type": "object" }, "swagCmsExtensionsBlockRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-block/9c16ffe823ddccc710bfb336c2ef30b6/swagCmsExtensionsBlockRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_block_rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c426e9e5d9031b933f89682d49bb02b1" } } } }, "type": "object" } }, "type": "object" }, "section": { "$ref": "#/components/schemas/CmsSection" }, "backgroundMedia": { "$ref": "#/components/schemas/Media" }, "slots": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSlot" } } }, "type": "object" }, "CmsPageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "entity": { "type": "string" }, "cssClass": { "type": "string" }, "config": { "properties": { "backgroundColor": { "type": "string" } }, "type": "object" }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "locked": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "drafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/drafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "4a25fb4d024699c2d82bbd0a651eb766" } } } } }, "type": "object" }, "activities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/activities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_activity" }, "id": { "type": "string", "example": "609f88983635a66fe4c8570afee066e0" } } } } }, "type": "object" }, "swagCmsExtensionsScrollNavigationPageSettings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/swagCmsExtensionsScrollNavigationPageSettings" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_scroll_navigation_page_settings" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8b835206d09f3dec1b733f6a78c7ba33" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "sections": { "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "entity": { "type": "string" }, "cssClass": { "type": "string" }, "config": { "properties": { "backgroundColor": { "type": "string" } }, "type": "object" }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "locked": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "drafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/drafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "4a25fb4d024699c2d82bbd0a651eb766" } } } } }, "type": "object" }, "activities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/activities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_activity" }, "id": { "type": "string", "example": "609f88983635a66fe4c8570afee066e0" } } } } }, "type": "object" }, "swagCmsExtensionsScrollNavigationPageSettings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/swagCmsExtensionsScrollNavigationPageSettings" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_scroll_navigation_page_settings" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8b835206d09f3dec1b733f6a78c7ba33" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" } }, "type": "object" }, "sections": { "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" }, "CmsPageActivityJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "pageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "draftVersion": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "details": { "type": "object", "readOnly": true }, "isMerged": { "type": "boolean", "readOnly": true }, "isDiscarded": { "type": "boolean", "readOnly": true }, "isReleasedAsNew": { "type": "boolean", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "cmsPage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page-activity/83bfa4f502ca5ead8a54e16782b24f8d/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page-activity/83bfa4f502ca5ead8a54e16782b24f8d/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" } ] }, "CmsPageActivity": { "required": ["id", "pageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "draftVersion": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "details": { "type": "object", "readOnly": true }, "isMerged": { "type": "boolean", "readOnly": true }, "isDiscarded": { "type": "boolean", "readOnly": true }, "isReleasedAsNew": { "type": "boolean", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "cmsPage": { "$ref": "#/components/schemas/CmsPage" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "CmsPageDraftJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "draftVersion", "deepLinkCode", "name", "pageId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "draftVersion": { "type": "string", "readOnly": true }, "deepLinkCode": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "ownerId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "cmsPage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page-draft/0478c327bbb2cd5c6f896c55a12e9961/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page-draft/0478c327bbb2cd5c6f896c55a12e9961/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "previewMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-page-draft/0478c327bbb2cd5c6f896c55a12e9961/previewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsPageDraft": { "required": ["id", "draftVersion", "deepLinkCode", "name", "pageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "draftVersion": { "type": "string", "readOnly": true }, "deepLinkCode": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "ownerId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "cmsPage": { "$ref": "#/components/schemas/CmsPage" }, "user": { "$ref": "#/components/schemas/User" }, "previewMedia": { "$ref": "#/components/schemas/Media" } }, "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": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "sizingMode": { "type": "string" }, "mobileBehavior": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { "type": "string" }, "cssClass": { "type": "string" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "properties": { "mobile": { "type": "boolean" }, "desktop": { "type": "boolean" }, "tablet": { "type": "boolean" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "swagCmsExtensionsScrollNavigation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/swagCmsExtensionsScrollNavigation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_scroll_navigation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "425b8d6ec722d74191c6d39370af19dc" } } } }, "type": "object" }, "dsrSlideExtension": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_cms_slide" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f7b1c34af8f346efae2c5862529520d8" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "page": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/page" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "71860c77c6745379b0d44304d66b6a13" } } } }, "type": "object" }, "backgroundMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/backgroundMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9f63714a30b4d0292695bd4d27235a0b" } } } }, "type": "object" }, "blocks": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/blocks" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "example": "e734964953f880e5164e32827950ff92" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsSection": { "description": "Added since version: 6.0.0.0", "required": ["id", "position", "type", "pageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "sizingMode": { "type": "string" }, "mobileBehavior": { "type": "string" }, "backgroundColor": { "type": "string" }, "backgroundMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { "type": "string" }, "cssClass": { "type": "string" }, "pageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "properties": { "mobile": { "type": "boolean" }, "desktop": { "type": "boolean" }, "tablet": { "type": "boolean" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "swagCmsExtensionsScrollNavigation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/swagCmsExtensionsScrollNavigation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_scroll_navigation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "425b8d6ec722d74191c6d39370af19dc" } } } }, "type": "object" }, "dsrSlideExtension": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_cms_slide" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f7b1c34af8f346efae2c5862529520d8" } } } }, "type": "object" } }, "type": "object" }, "page": { "$ref": "#/components/schemas/CmsPage" }, "backgroundMedia": { "$ref": "#/components/schemas/Media" }, "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } } }, "type": "object" }, "CmsSlotJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type", "slot", "blockId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fieldConfig": { "type": "object" }, "type": { "type": "string" }, "slot": { "type": "string" }, "locked": { "type": "boolean" }, "config": { "type": "object" }, "customFields": { "type": "object" }, "data": { "type": "object", "readOnly": true }, "blockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "swagCmsExtensionsForm": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/swagCmsExtensionsForm" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0654ad514da002e9d77fa24ee33acd95" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "block": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "14511f2f5564650d129ca7cabc333278" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": ["id", "type", "slot", "blockId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fieldConfig": { "type": "object" }, "type": { "type": "string" }, "slot": { "type": "string" }, "locked": { "type": "boolean" }, "config": { "type": "object" }, "customFields": { "type": "object" }, "data": { "type": "object", "readOnly": true }, "blockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "swagCmsExtensionsForm": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/swagCmsExtensionsForm" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0654ad514da002e9d77fa24ee33acd95" } } } }, "type": "object" } }, "type": "object" }, "block": { "$ref": "#/components/schemas/CmsBlock" } }, "type": "object" }, "CountryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "addressFormat"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "iso": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "shippingAvailable": { "type": "boolean" }, "iso3": { "type": "string" }, "displayStateInRegistration": { "type": "boolean" }, "forceStateInRegistration": { "type": "boolean" }, "checkVatIdPattern": { "type": "boolean" }, "vatIdRequired": { "type": "boolean" }, "vatIdPattern": { "type": "string" }, "customFields": { "type": "object" }, "customerTax": { "required": ["enabled", "currencyId", "amount"], "properties": { "enabled": { "type": "boolean" }, "currencyId": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "companyTax": { "required": ["enabled", "currencyId", "amount"], "properties": { "enabled": { "type": "boolean" }, "currencyId": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "postalCodeRequired": { "type": "boolean" }, "checkPostalCodePattern": { "type": "boolean" }, "checkAdvancedPostalCodePattern": { "type": "boolean" }, "advancedPostalCodePattern": { "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { "type": "string" }, "isEu": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "name": { "type": "string" }, "iso": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "shippingAvailable": { "type": "boolean" }, "iso3": { "type": "string" }, "displayStateInRegistration": { "type": "boolean" }, "forceStateInRegistration": { "type": "boolean" }, "checkVatIdPattern": { "type": "boolean" }, "vatIdRequired": { "type": "boolean" }, "vatIdPattern": { "type": "string" }, "customFields": { "type": "object" }, "customerTax": { "required": ["enabled", "currencyId", "amount"], "properties": { "enabled": { "type": "boolean" }, "currencyId": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "companyTax": { "required": ["enabled", "currencyId", "amount"], "properties": { "enabled": { "type": "boolean" }, "currencyId": { "type": "string" }, "amount": { "type": "number", "format": "float" } }, "type": "object" }, "postalCodeRequired": { "type": "boolean" }, "checkPostalCodePattern": { "type": "boolean" }, "checkAdvancedPostalCodePattern": { "type": "boolean" }, "advancedPostalCodePattern": { "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { "type": "string" }, "isEu": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "states": { "description": "States/provinces/regions within the country", "type": "array", "items": { "$ref": "#/components/schemas/CountryState" } }, "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "orderAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "taxRules": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } }, "currencyCountryRoundings": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, "type": "object" }, "CountryStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "countryId", "shortCode", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "customerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } } }, "type": "object" }, "orderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "c3182f0dc0cc20b4982616d3e0221747" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CountryState": { "description": "Added since version: 6.0.0.0", "required": ["id", "countryId", "shortCode", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "country": { "$ref": "#/components/schemas/Country" }, "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "orderAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } } }, "type": "object" }, "CurrencyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "factor", "symbol", "isoCode", "itemRounding", "totalRounding", "shortName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "factor": { "type": "number", "format": "float" }, "symbol": { "type": "string" }, "isoCode": { "type": "string" }, "shortName": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "isSystemDefault": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "taxFreeFrom": { "type": "number", "format": "float" }, "customFields": { "type": "object" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "salesChannelDomains": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDomains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } } }, "type": "object" }, "promotionDiscountPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/promotionDiscountPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount_prices" }, "id": { "type": "string", "example": "325723473ecab76b0f45e1554513f779" } } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" }, "countryRoundings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "currency_country_rounding" }, "id": { "type": "string", "example": "3de4aa80c8c8822ea10d156a6f58d6f7" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", "factor", "symbol", "isoCode", "itemRounding", "totalRounding", "shortName", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "factor": { "type": "number", "format": "float" }, "symbol": { "type": "string" }, "isoCode": { "type": "string" }, "shortName": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "isSystemDefault": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "taxFreeFrom": { "type": "number", "format": "float" }, "customFields": { "type": "object" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "salesChannelDomains": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } }, "promotionDiscountPrices": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } }, "countryRoundings": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, "type": "object" }, "CurrencyCountryRoundingJsonApi": { "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "currencyId", "countryId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", "required": [ "id", "currencyId", "countryId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "currency": { "$ref": "#/components/schemas/Currency" }, "country": { "$ref": "#/components/schemas/Country" } }, "type": "object" }, "CustomEntityJsonApi": { "description": "Added since version: 6.4.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "fields"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "fields": { "type": "object" }, "flags": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsAware": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "storeApiAware": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "customFieldsAware": { "type": "boolean" }, "labelProperty": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "CustomEntity": { "description": "Added since version: 6.4.9.0", "required": ["id", "name", "fields"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "fields": { "type": "object" }, "flags": { "type": "object" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsAware": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "storeApiAware": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "customFieldsAware": { "type": "boolean" }, "labelProperty": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "CustomFieldJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "config": { "type": "object" }, "active": { "type": "boolean" }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { "type": "boolean" }, "allowCartExpose": { "type": "boolean" }, "storeApiAware": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFieldSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, "productSearchConfigFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config_field" }, "id": { "type": "string", "example": "ae6a70432f71d6905502769f184399b1" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomField": { "description": "Added since version: 6.0.0.0", "required": ["id", "name", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "config": { "type": "object" }, "active": { "type": "boolean" }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { "type": "boolean" }, "allowCartExpose": { "type": "boolean" }, "storeApiAware": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" }, "productSearchConfigFields": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } }, "type": "object" }, "CustomFieldSetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "config": { "type": "object" }, "active": { "type": "boolean" }, "global": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field" }, "id": { "type": "string", "example": "4e252ff73243c27b4df9002e452fc6a7" } } } } }, "type": "object" }, "relations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set_relation" }, "id": { "type": "string", "example": "06c5b10273a69992d8c6933e294909fa" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "config": { "type": "object" }, "active": { "type": "boolean" }, "global": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldSetRelation" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "CustomFieldSetRelationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "customFieldSetId", "entityName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customFieldSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": ["id", "customFieldSetId", "entityName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, "CustomPriceJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "price"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "customerGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomPrice": { "required": ["id", "productId", "price"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "CustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "groupId", "salesChannelId", "languageId", "defaultBillingAddressId", "defaultShippingAddressId", "customerNumber", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "customerNumber": { "type": "string" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "title": { "type": "string" }, "affiliateCode": { "type": "string" }, "campaignCode": { "type": "string" }, "active": { "type": "boolean" }, "doubleOptInRegistration": { "type": "boolean" }, "doubleOptInEmailSentDate": { "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { "type": "string", "format": "date-time" }, "hash": { "type": "string" }, "guest": { "type": "boolean" }, "firstLogin": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "birthday": { "type": "string" }, "lastOrderDate": { "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { "type": "number", "format": "float", "readOnly": true }, "reviewCount": { "type": "integer", "format": "int64", "readOnly": true }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "requestedGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" }, "subscriptionCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_customer" }, "id": { "type": "string", "example": "ee8811605866488e8f21308857e1e5a8" } } } } }, "type": "object" }, "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "employees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } } }, "type": "object" }, "roles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "example": "4295e8065f2f640103f566df3329e17f" } } } } }, "type": "object" }, "b2bBusinessPartner": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, "specificFeatures": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_specific_features" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } } } }, "type": "object" }, "ssoProviderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider_customer" }, "id": { "type": "string", "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" }, "organizationUnits": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "4ab85f040b199b758bfb81e383c50b4b" } } } } }, "type": "object" }, "attendee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } } }, "type": "object" }, "paypalVaultTokens": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/paypalVaultTokens" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token" }, "id": { "type": "string", "example": "7e423eeb595163d20591951433de150c" } } } } }, "type": "object" }, "paypalVaultTokenMappings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/paypalVaultTokenMappings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token_mapping" }, "id": { "type": "string", "example": "75fb7d13a771c74947402295ed591499" } } } } }, "type": "object" }, "swagSocialShoppingCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/swagSocialShoppingCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70825a5dfabd078bce265301ba7d9cca" } } } }, "type": "object" }, "b2bApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "545759fb10fcbebd03f04277239baace" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" } }, "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}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "customerNumber": { "type": "string" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "title": { "type": "string" }, "affiliateCode": { "type": "string" }, "campaignCode": { "type": "string" }, "active": { "type": "boolean" }, "doubleOptInRegistration": { "type": "boolean" }, "doubleOptInEmailSentDate": { "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { "type": "string", "format": "date-time" }, "hash": { "type": "string" }, "guest": { "type": "boolean" }, "firstLogin": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "birthday": { "type": "string" }, "lastOrderDate": { "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { "type": "number", "format": "float", "readOnly": true }, "reviewCount": { "type": "integer", "format": "int64", "readOnly": true }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "requestedGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" }, "subscriptionCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_customer" }, "id": { "type": "string", "example": "ee8811605866488e8f21308857e1e5a8" } } } } }, "type": "object" }, "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "employees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } } }, "type": "object" }, "roles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_role" }, "id": { "type": "string", "example": "4295e8065f2f640103f566df3329e17f" } } } } }, "type": "object" }, "b2bBusinessPartner": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, "specificFeatures": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_specific_features" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } } } }, "type": "object" }, "ssoProviderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider_customer" }, "id": { "type": "string", "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" }, "organizationUnits": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "4ab85f040b199b758bfb81e383c50b4b" } } } } }, "type": "object" }, "attendee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } } }, "type": "object" }, "paypalVaultTokens": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/paypalVaultTokens" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token" }, "id": { "type": "string", "example": "7e423eeb595163d20591951433de150c" } } } } }, "type": "object" }, "paypalVaultTokenMappings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/paypalVaultTokenMappings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token_mapping" }, "id": { "type": "string", "example": "75fb7d13a771c74947402295ed591499" } } } } }, "type": "object" }, "swagSocialShoppingCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/swagSocialShoppingCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70825a5dfabd078bce265301ba7d9cca" } } } }, "type": "object" }, "b2bApprovalRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule" }, "id": { "type": "string", "example": "545759fb10fcbebd03f04277239baace" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" } }, "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" } }, "type": "object" }, "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "customerId", "countryId", "firstName", "lastName", "city", "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "street": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organizationCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", "example": "ada6a19a929bea8dbec29edb3d68df58" } } } } }, "type": "object" }, "organizationDefaultShippingAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "789476f40e97708274b7ff68e5dfd729" } } } } }, "type": "object" }, "organizationDefaultBillingAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "7b0213487f5e71c973532f6f31740e5a" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "countryState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", "customerId", "countryId", "firstName", "lastName", "city", "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "street": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organizationCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization_customer_address" }, "id": { "type": "string", "example": "ada6a19a929bea8dbec29edb3d68df58" } } } } }, "type": "object" }, "organizationDefaultShippingAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "789476f40e97708274b7ff68e5dfd729" } } } } }, "type": "object" }, "organizationDefaultBillingAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "7b0213487f5e71c973532f6f31740e5a" } } } } }, "type": "object" } }, "type": "object" }, "customer": { "$ref": "#/components/schemas/Customer" }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "CustomerGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "displayGross": { "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { "type": "boolean" }, "registrationTitle": { "type": "string" }, "registrationIntroduction": { "type": "string" }, "registrationOnlyCompanyRegistration": { "type": "boolean" }, "registrationSeoMetaDescription": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "registrationSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "ffc8e76c1fe257d563b9d0024a50620b" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "displayGross": { "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { "type": "boolean" }, "registrationTitle": { "type": "string" }, "registrationIntroduction": { "type": "string" }, "registrationOnlyCompanyRegistration": { "type": "boolean" }, "registrationSeoMetaDescription": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" } }, "type": "object" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "registrationSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "CustomerGroupRegistrationSalesChannels": { "description": "Added since version: 6.3.1.0", "required": ["customerGroupId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "CustomerRecoveryJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "hash", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerRecovery": { "description": "Added since version: 6.1.0.0", "required": ["id", "hash", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "CustomerSpecificFeaturesJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "customerId", "features"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "features": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerSpecificFeatures": { "required": ["id", "customerId", "features"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "features": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "CustomerTag": { "description": "Added since version: 6.0.0.0", "required": ["customerId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customer": { "$ref": "#/components/schemas/Customer" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "CustomerWishlistJsonApi": { "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "customerId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist_product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerWishlist": { "description": "Added since version: 6.3.4.0", "required": ["id", "customerId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerWishlistProduct" } }, "customer": { "$ref": "#/components/schemas/Customer" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "CustomerWishlistProductJsonApi": { "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "wishlistId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "wishlist": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_wishlist" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "723edf7c24638ed18d2fa831e647a5cc" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "CustomerWishlistProduct": { "description": "Added since version: 6.3.4.0", "required": ["id", "productId", "wishlistId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "wishlist": { "$ref": "#/components/schemas/CustomerWishlist" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "DeliveryTimeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "min", "max", "unit"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "min": { "type": "integer", "format": "int64" }, "max": { "type": "integer", "format": "int64" }, "unit": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": ["id", "name", "min", "max", "unit"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "min": { "type": "integer", "format": "int64" }, "max": { "type": "integer", "format": "int64" }, "unit": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "DocumentJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentTypeId", "orderId", "config", "deepLinkCode" ], "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" } }, "type": "object" } }, "type": "object" } ] }, "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", "documentTypeId", "orderId", "config", "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "config": { "type": "object" }, "sent": { "type": "boolean" }, "static": { "type": "boolean" }, "deepLinkCode": { "type": "string" }, "documentNumber": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "order": { "$ref": "#/components/schemas/Order" }, "referencedDocument": { "$ref": "#/components/schemas/Document" }, "dependentDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "documentMediaFile": { "$ref": "#/components/schemas/Media" }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "DocumentBaseConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "documentTypeId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "filenamePrefix": { "type": "string" }, "filenameSuffix": { "type": "string" }, "global": { "type": "boolean" }, "documentNumber": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "object" }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "logo": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config_sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": ["id", "documentTypeId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "filenamePrefix": { "type": "string" }, "filenameSuffix": { "type": "string" }, "global": { "type": "boolean" }, "documentNumber": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "object" }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "logo": { "$ref": "#/components/schemas/Media" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } }, "type": "object" }, "DocumentBaseConfigSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "documentBaseConfigId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "documentBaseConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56e59df02965ebf8eadea49fa0aadd47" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": ["id", "documentBaseConfigId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "documentBaseConfig": { "$ref": "#/components/schemas/DocumentBaseConfig" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "object" }, "translated": { "type": "object" }, "extensions": { "properties": { "quoteDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_document" }, "id": { "type": "string", "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "documents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document" }, "id": { "type": "string", "example": "21f64da1e5792c8295b964d159a14491" } } } } }, "type": "object" }, "documentBaseConfigs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config" }, "id": { "type": "string", "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } } }, "type": "object" }, "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "document_base_config_sales_channel" }, "id": { "type": "string", "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DocumentType": { "description": "Added since version: 6.0.0.0", "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customFields": { "type": "object" }, "translated": { "type": "object" }, "extensions": { "properties": { "quoteDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_document" }, "id": { "type": "string", "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" } }, "type": "object" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "documentBaseConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } }, "documentBaseConfigSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } }, "type": "object" }, "DsrAppointmentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "presentationId", "salesChannelDomainId", "presentationPath", "name", "createdById" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "dsrPresentationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationPath": { "type": "string" }, "accessibleFrom": { "type": "string", "format": "date-time" }, "accessibleTo": { "type": "string", "format": "date-time" }, "attendeeRuleIds": { "type": "object" }, "guideUserId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mode": { "type": "string" }, "message": { "type": "string" }, "attendeeRestrictionType": { "type": "string" }, "isPreview": { "type": "boolean" }, "videoAudioSettings": { "type": "string" }, "name": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "canSendRequestEmail": { "type": "boolean" }, "canBookNewAppointment": { "type": "boolean" }, "bookingLink": { "type": "string" }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "presentation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/presentation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2486923a98e77fd0740381d01acd1782" } } } }, "type": "object" }, "videoChat": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/videoChat" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_video_chat" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b23b1765cc6500512065f5a39a713b75" } } } }, "type": "object" }, "guideUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/guideUser" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7d58fd6cf68b2c4c00b51069f10a25eb" } } } }, "type": "object" }, "salesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/salesChannelDomain" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "29c8b34b04e94e35e95e8346954b7fb4" } } } }, "type": "object" }, "attendees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/attendees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "example": "4d77992a742c290d1e37290f3986fd4e" } } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrAppointment": { "required": [ "id", "presentationId", "salesChannelDomainId", "presentationPath", "name", "createdById" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "dsrPresentationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationPath": { "type": "string" }, "accessibleFrom": { "type": "string", "format": "date-time" }, "accessibleTo": { "type": "string", "format": "date-time" }, "attendeeRuleIds": { "type": "object" }, "guideUserId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mode": { "type": "string" }, "message": { "type": "string" }, "attendeeRestrictionType": { "type": "string" }, "isPreview": { "type": "boolean" }, "videoAudioSettings": { "type": "string" }, "name": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "canSendRequestEmail": { "type": "boolean" }, "canBookNewAppointment": { "type": "boolean" }, "bookingLink": { "type": "string" }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "presentation": { "$ref": "#/components/schemas/DsrPresentation" }, "videoChat": { "$ref": "#/components/schemas/DsrAppointmentVideoChat" }, "guideUser": { "$ref": "#/components/schemas/User" }, "salesChannelDomain": { "$ref": "#/components/schemas/SalesChannelDomain" }, "attendees": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "DsrAppointmentAttendeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appointmentId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "videoUserId": { "type": "string" }, "attendeeName": { "type": "string" }, "attendeeEmail": { "type": "string" }, "type": { "type": "string" }, "invitationStatus": { "type": "string" }, "joinedAt": { "type": "string", "format": "date-time" }, "lastActive": { "type": "string", "format": "date-time" }, "isBlocked": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "appointment": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/appointment" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b1caa385c37f1fec467494c8fde4f49b" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "interactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/interactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_interaction" }, "id": { "type": "string", "example": "85aa9c704a544e104741012bf72b6572" } } } } }, "type": "object" }, "productCollections": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/productCollections" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_attendee_product_collection" }, "id": { "type": "string", "example": "3fa1ecbee1fa3d24671a2e81d9b71d17" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrAppointmentAttendee": { "required": ["id", "appointmentId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "videoUserId": { "type": "string" }, "attendeeName": { "type": "string" }, "attendeeEmail": { "type": "string" }, "type": { "type": "string" }, "invitationStatus": { "type": "string" }, "joinedAt": { "type": "string", "format": "date-time" }, "lastActive": { "type": "string", "format": "date-time" }, "isBlocked": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "appointment": { "$ref": "#/components/schemas/DsrAppointment" }, "customer": { "$ref": "#/components/schemas/Customer" }, "user": { "$ref": "#/components/schemas/User" }, "interactions": { "type": "array", "items": { "$ref": "#/components/schemas/DsrInteraction" } }, "productCollections": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } }, "type": "object" }, "DsrAppointmentRequestJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "appointmentId", "salutationId", "firstName", "lastName", "emailAddress", "subject" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "emailAddress": { "type": "string" }, "phoneNumber": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "requestedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handledById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "appointment": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/appointment" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b1caa385c37f1fec467494c8fde4f49b" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, "requester": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/requester" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0bc2b09c07005b410cae62912ae70206" } } } }, "type": "object" }, "handler": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/handler" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1cbfe271a40788a00e8bf8574d94d4b" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrAppointmentRequest": { "required": [ "id", "appointmentId", "salutationId", "firstName", "lastName", "emailAddress", "subject" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "emailAddress": { "type": "string" }, "phoneNumber": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "requestedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handledById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "appointment": { "$ref": "#/components/schemas/DsrAppointment" }, "salutation": { "$ref": "#/components/schemas/Salutation" }, "requester": { "$ref": "#/components/schemas/DsrAppointmentAttendee" }, "handler": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "DsrAppointmentVideoChatJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appointmentId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "ownerToken": { "type": "string" }, "userToken": { "type": "string" }, "url": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "appointment": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-appointment-video-chat/21851f23492d55e9e0c82d97fd789730/appointment" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b1caa385c37f1fec467494c8fde4f49b" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrAppointmentVideoChat": { "required": ["id", "appointmentId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appointmentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "ownerToken": { "type": "string" }, "userToken": { "type": "string" }, "url": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "appointment": { "$ref": "#/components/schemas/DsrAppointment" } }, "type": "object" }, "DsrAttendeeProductCollectionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "attendeeId", "productId", "alias"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "alias": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "attendee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-attendee-product-collection/a8b5d04acd1993d5f7b24baee1b1fc33/attendee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-attendee-product-collection/a8b5d04acd1993d5f7b24baee1b1fc33/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrAttendeeProductCollection": { "required": ["id", "attendeeId", "productId", "alias"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "alias": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "attendee": { "$ref": "#/components/schemas/DsrAppointmentAttendee" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "DsrCmsSlideJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "slideName", "cmsSectionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "slideName": { "type": "string" }, "cmsSectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "cmsSection": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-cms-slide/35f9e2e1b6a51eabbee81458ba860d95/cmsSection" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "212545e6991db0675b783d4574ab20dc" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrCmsSlide": { "required": ["id", "slideName", "cmsSectionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "slideName": { "type": "string" }, "cmsSectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "cmsSection": { "$ref": "#/components/schemas/CmsSection" } }, "type": "object" }, "DsrInteractionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "triggeredAt", "attendeeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "triggeredAt": { "type": "string", "format": "date-time" }, "payload": { "type": "object" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "attendee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-interaction/3d3949b2e83fa3ca98a32f354273a62a/attendee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment_attendee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrInteraction": { "required": ["id", "name", "triggeredAt", "attendeeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "triggeredAt": { "type": "string", "format": "date-time" }, "payload": { "type": "object" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "attendee": { "$ref": "#/components/schemas/DsrAppointmentAttendee" } }, "type": "object" }, "DsrPresentationJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "createdById", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "appointments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/appointments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "2417b53255206bdce189add39d85fca1" } } } } }, "type": "object" }, "cmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/cmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_cms_page" }, "id": { "type": "string", "example": "e676148cc6ffb82b89b3903ecaed2d16" } } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrPresentation": { "required": ["id", "createdById", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "parent": { "$ref": "#/components/schemas/DsrPresentation" }, "appointments": { "type": "array", "items": { "$ref": "#/components/schemas/DsrAppointment" } }, "cmsPages": { "type": "array", "items": { "$ref": "#/components/schemas/DsrPresentationCmsPage" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "DsrPresentationCmsPageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "presentationId", "cmsPageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "dsrPresentationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "title": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pickedProductIds": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "isInstantListing": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "presentation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/presentation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2486923a98e77fd0740381d01acd1782" } } } }, "type": "object" }, "cmsPage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DsrPresentationCmsPage": { "description": "Added since version: 6.0.0.0", "required": ["id", "presentationId", "cmsPageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "presentationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "dsrPresentationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "title": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pickedProductIds": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "isInstantListing": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "presentation": { "$ref": "#/components/schemas/DsrPresentation" }, "cmsPage": { "$ref": "#/components/schemas/CmsPage" }, "product": { "$ref": "#/components/schemas/Product" }, "productStream": { "$ref": "#/components/schemas/ProductStream" } }, "type": "object" }, "FlowJsonApi": { "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "eventName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "eventName": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "invalid": { "type": "boolean", "readOnly": true }, "active": { "type": "boolean" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "sequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "eb6710ddc89dae357ae94ca3974b1e38" } } } } }, "type": "object" }, "appFlowEvent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_event" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d92d404135abc21e31337d9509cbe62f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Flow": { "description": "Added since version: 6.4.6.0", "required": ["id", "name", "eventName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "eventName": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "invalid": { "type": "boolean", "readOnly": true }, "active": { "type": "boolean" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" } }, "type": "object" }, "sequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "appFlowEvent": { "$ref": "#/components/schemas/AppFlowEvent" } }, "type": "object" }, "FlowSequenceJsonApi": { "description": "Added since version: 6.4.6.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "flowId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { "type": "string" }, "config": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "displayGroup": { "type": "integer", "format": "int64" }, "trueCase": { "type": "boolean" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "appFlowActionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "webhookEventLogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "webhook_event_log" }, "id": { "type": "string", "example": "82557f6f51ca956bee524cede1375331" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "flow": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "appFlowAction": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_flow_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8ba9ae8a60ecf9be421e333b95703a68" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "FlowSequence": { "description": "Added since version: 6.4.6.0", "required": ["id", "flowId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { "type": "string" }, "config": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "displayGroup": { "type": "integer", "format": "int64" }, "trueCase": { "type": "boolean" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "appFlowActionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "webhookEventLogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "webhook_event_log" }, "id": { "type": "string", "example": "82557f6f51ca956bee524cede1375331" } } } } }, "type": "object" } }, "type": "object" }, "flow": { "$ref": "#/components/schemas/Flow" }, "rule": { "$ref": "#/components/schemas/Rule" }, "parent": { "$ref": "#/components/schemas/FlowSequence" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "appFlowAction": { "$ref": "#/components/schemas/AppFlowAction" } }, "type": "object" }, "FlowTemplateJsonApi": { "description": "Added since version: 6.4.18.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "FlowTemplate": { "description": "Added since version: 6.4.18.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "ImportExportFileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "originalName", "path", "expireDate"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalName": { "type": "string" }, "path": { "type": "string" }, "expireDate": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" }, "accessToken": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "log": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ImportExportFile": { "description": "Added since version: 6.0.0.0", "required": ["id", "originalName", "path", "expireDate"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalName": { "type": "string" }, "path": { "type": "string" }, "expireDate": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" }, "accessToken": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "log": { "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, "ImportExportLogJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "activity", "state", "records", "config"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activity": { "type": "string" }, "state": { "type": "string" }, "records": { "type": "integer", "format": "int64" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "profileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "invalidRecordsLogId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "type": "string" }, "profileName": { "type": "string" }, "config": { "type": "object" }, "result": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "profile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_profile" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7d97481b1fe66f4b51db90da7e794d9f" } } } }, "type": "object" }, "file": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_file" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8c7dd922ad47494fc02c388e12c00eac" } } } }, "type": "object" }, "invalidRecordsLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "46eeeb74b58b97a6a05494fa0024c998" } } } }, "type": "object" }, "failedImportLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1d6996fa1560fc40e5faad086b07ad18" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ImportExportLog": { "description": "Added since version: 6.0.0.0", "required": ["id", "activity", "state", "records", "config"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activity": { "type": "string" }, "state": { "type": "string" }, "records": { "type": "integer", "format": "int64" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "profileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "invalidRecordsLogId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "type": "string" }, "profileName": { "type": "string" }, "config": { "type": "object" }, "result": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" }, "profile": { "$ref": "#/components/schemas/ImportExportProfile" }, "file": { "$ref": "#/components/schemas/ImportExportFile" }, "invalidRecordsLog": { "$ref": "#/components/schemas/ImportExportLog" }, "failedImportLog": { "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, "ImportExportProfileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "technicalName", "label", "sourceEntity", "fileType", "delimiter", "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "systemDefault": { "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { "type": "string" }, "delimiter": { "type": "string" }, "enclosure": { "type": "string" }, "mapping": { "type": "object" }, "updateBy": { "type": "object" }, "config": { "type": "object" }, "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}$" }, "technicalName": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "systemDefault": { "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { "type": "string" }, "delimiter": { "type": "string" }, "enclosure": { "type": "string" }, "mapping": { "type": "object" }, "updateBy": { "type": "object" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "importExportLogs": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } } }, "type": "object" }, "IntegrationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "label", "accessKey", "secretAccessKey"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "label": { "type": "string" }, "accessKey": { "type": "string" }, "secretAccessKey": { "type": "string" }, "lastUsageAt": { "type": "string", "format": "date-time" }, "admin": { "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "createdNotifications": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, "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}$" }, "label": { "type": "string" }, "accessKey": { "type": "string" }, "secretAccessKey": { "type": "string" }, "lastUsageAt": { "type": "string", "format": "date-time" }, "admin": { "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "createdNotifications": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "notification" }, "id": { "type": "string", "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" } }, "type": "object" }, "app": { "$ref": "#/components/schemas/App" }, "stateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "aclRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } } }, "type": "object" }, "IntegrationRole": { "description": "Added since version: 6.3.3.0", "required": ["integrationId", "aclRoleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integration": { "$ref": "#/components/schemas/Integration" }, "role": { "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, "LandingPageJsonApi": { "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "url"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "metaTitle": { "type": "string" }, "metaDescription": { "type": "string" }, "keywords": { "type": "string" }, "url": { "type": "string" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" } }, "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}$" }, "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" }, "extensions": { "properties": { "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" } }, "type": "object" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { "$ref": "#/components/schemas/CmsPage", "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "seoUrls": { "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" } } }, "type": "object" }, "LandingPageSalesChannel": { "description": "Added since version: 6.4.0.0", "required": ["landingPageId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPage": { "$ref": "#/components/schemas/LandingPage" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "LandingPageTag": { "description": "Added since version: 6.4.0.0", "required": ["landingPageId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPage": { "$ref": "#/components/schemas/LandingPage" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "LanguageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "localeId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "mediaAiTagTranslation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_ai_tag_translation" }, "id": { "type": "string", "example": "e78da60cc3106508ef465909fa4cb138" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "presentationTranslation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_translation" }, "id": { "type": "string", "example": "e22d79f2b1909484a375a5dc228ef751" } } } } }, "type": "object" }, "swagLanguagePackLanguage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/swagLanguagePackLanguage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_language_pack_language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b0e2ae26691394a06d0fd87b9f97605b" } } } }, "type": "object" }, "b2bEmployees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "2193894cca6bb5864b8607f09be77ace" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bAppScriptConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule_app_script_condition_translation" }, "id": { "type": "string", "example": "880f55611c0f2ac1026271d799698c6e" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "locale": { "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}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "mediaAiTagTranslation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_ai_tag_translation" }, "id": { "type": "string", "example": "e78da60cc3106508ef465909fa4cb138" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "presentationTranslation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_translation" }, "id": { "type": "string", "example": "e22d79f2b1909484a375a5dc228ef751" } } } } }, "type": "object" }, "swagLanguagePackLanguage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/swagLanguagePackLanguage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_language_pack_language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b0e2ae26691394a06d0fd87b9f97605b" } } } }, "type": "object" }, "b2bEmployees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "example": "2193894cca6bb5864b8607f09be77ace" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "b2bAppScriptConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_approval_rule_app_script_condition_translation" }, "id": { "type": "string", "example": "880f55611c0f2ac1026271d799698c6e" } } } } }, "type": "object" } }, "type": "object" }, "parent": { "$ref": "#/components/schemas/Language" }, "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": { "type": "string" }, "name": { "type": "string" }, "territory": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "languages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "example": "f3e334d42863e8250c7d03efefbfd387" } } } } }, "type": "object" }, "users": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "example": "9bc65c2abec141778ffaa729489f3e87" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Locale": { "description": "Added since version: 6.0.0.0", "required": ["id", "code", "name", "territory"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "type": "string" }, "name": { "type": "string" }, "territory": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "type": "object" }, "LogEntryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "message": { "type": "string" }, "level": { "type": "integer", "format": "int64" }, "channel": { "type": "string" }, "context": { "type": "object" }, "extra": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "LogEntry": { "description": "Added since version: 6.0.0.0", "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "message": { "type": "string" }, "level": { "type": "integer", "format": "int64" }, "channel": { "type": "string" }, "context": { "type": "object" }, "extra": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "MailHeaderFooterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "headerHtml": { "type": "string" }, "headerPlain": { "type": "string" }, "footerHtml": { "type": "string" }, "footerPlain": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "headerHtml": { "type": "string" }, "headerPlain": { "type": "string" }, "footerHtml": { "type": "string" }, "footerPlain": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "MailTemplateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "mailTemplateTypeId", "subject", "contentHtml", "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailTemplateTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "senderName": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "contentHtml": { "type": "string" }, "contentPlain": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "swagCmsExtensionsForms": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/swagCmsExtensionsForms" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form" }, "id": { "type": "string", "example": "a08561237fe1e2a012502c820a08405d" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "mailTemplateType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template_media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ "id", "mailTemplateTypeId", "subject", "contentHtml", "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailTemplateTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "systemDefault": { "type": "boolean" }, "senderName": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "contentHtml": { "type": "string" }, "contentPlain": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "swagCmsExtensionsForms": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/swagCmsExtensionsForms" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form" }, "id": { "type": "string", "example": "a08561237fe1e2a012502c820a08405d" } } } } }, "type": "object" } }, "type": "object" }, "mailTemplateType": { "$ref": "#/components/schemas/MailTemplateType" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateMedia" } } }, "type": "object" }, "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", "required": ["id", "mailTemplateId", "languageId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailTemplateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "mailTemplate": { "$ref": "#/components/schemas/MailTemplate" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "MailTemplateTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "availableEntities": { "type": "object" }, "customFields": { "type": "object" }, "templateData": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "mailTemplates": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template" }, "id": { "type": "string", "example": "e6f502f7d88de75db45325d22998cf6d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "availableEntities": { "type": "object" }, "customFields": { "type": "object" }, "templateData": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "mailTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplate" } } }, "type": "object" }, "MainCategoryJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "categoryId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "category": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c4ef352f74e502ef5e7bc98e6f4e493d" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MainCategory": { "description": "Added since version: 6.1.0.0", "required": ["id", "productId", "categoryId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { "type": "string" }, "fileExtension": { "type": "string" }, "uploadedAt": { "type": "string", "format": "date-time", "readOnly": true }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64", "readOnly": true }, "metaData": { "type": "object", "readOnly": true }, "mediaType": { "type": "object", "readOnly": true }, "config": { "type": "object" }, "alt": { "type": "string" }, "title": { "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { "type": "string" }, "hasFile": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "private": { "type": "boolean" }, "customFields": { "type": "object" }, "fileHash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" }, "themeMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "260be9ecb281c4ff04e7189bb18a35bd" } } } } }, "type": "object" }, "mediaAiTag": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_ai_tag" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3c88197809d464216a8c40a8db191b38" } } } }, "type": "object" }, "ssoProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider" }, "id": { "type": "string", "example": "520b66891556bf9309da72937c4f1f98" } } } } }, "type": "object" }, "quoteDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_document" }, "id": { "type": "string", "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" }, "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" }, "spatialObjects": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_object" }, "id": { "type": "string", "example": "ad6bd8458100c1c7b8a7d1478a4ba188" } } } } }, "type": "object" }, "cmsPageDrafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPageDrafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "93c0df75844858f2b2a9359abc152f5d" } } } } }, "type": "object" }, "swagCustomizedProductsTemplate": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/swagCustomizedProductsTemplate" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "example": "6e9fad30dd3cb84748a01bb8152f4769" } } } } }, "type": "object" }, "ceSpatialPreviewMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ceSpatialPreviewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "ce_spatial_preview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1533e657fb4c238df9af880362a3047" } } } }, "type": "object" }, "ceSpatialPreviewPreview": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ceSpatialPreviewPreview" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "ce_spatial_preview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "30874b947f737e8baac7e58cd441f9d1" } } } }, "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" }, "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" } }, "type": "object" } }, "type": "object" } ] }, "Media": { "description": "Added since version: 6.0.0.0", "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { "type": "string" }, "fileExtension": { "type": "string" }, "uploadedAt": { "type": "string", "format": "date-time", "readOnly": true }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64", "readOnly": true }, "metaData": { "type": "object", "readOnly": true }, "mediaType": { "type": "object", "readOnly": true }, "config": { "type": "object" }, "alt": { "type": "string" }, "title": { "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { "type": "string" }, "hasFile": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "private": { "type": "boolean" }, "customFields": { "type": "object" }, "fileHash": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" }, "themeMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "260be9ecb281c4ff04e7189bb18a35bd" } } } } }, "type": "object" }, "mediaAiTag": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_ai_tag" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3c88197809d464216a8c40a8db191b38" } } } }, "type": "object" }, "ssoProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider" }, "id": { "type": "string", "example": "520b66891556bf9309da72937c4f1f98" } } } } }, "type": "object" }, "quoteDocuments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_document" }, "id": { "type": "string", "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" }, "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" }, "spatialObjects": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_object" }, "id": { "type": "string", "example": "ad6bd8458100c1c7b8a7d1478a4ba188" } } } } }, "type": "object" }, "cmsPageDrafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPageDrafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "93c0df75844858f2b2a9359abc152f5d" } } } } }, "type": "object" }, "swagCustomizedProductsTemplate": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/swagCustomizedProductsTemplate" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "example": "6e9fad30dd3cb84748a01bb8152f4769" } } } } }, "type": "object" }, "ceSpatialPreviewMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ceSpatialPreviewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "ce_spatial_preview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "c1533e657fb4c238df9af880362a3047" } } } }, "type": "object" }, "ceSpatialPreviewPreview": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media/3b563524fdb17b4a86590470d40bef74/ceSpatialPreviewPreview" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "ce_spatial_preview" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "30874b947f737e8baac7e58cd441f9d1" } } } }, "type": "object" } }, "type": "object" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "thumbnails": { "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" } }, "user": { "$ref": "#/components/schemas/User" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "productManufacturers": { "type": "array", "items": { "$ref": "#/components/schemas/ProductManufacturer" } }, "productMedia": { "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } }, "productDownloads": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "orderLineItemDownloads": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" } }, "avatarUsers": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "mediaFolder": { "$ref": "#/components/schemas/MediaFolder" }, "propertyGroupOptions": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "mailTemplateMedia": { "type": "array", "items": { "$ref": "#/components/schemas/MailTemplateMedia" } }, "documentBaseConfigs": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentBaseConfig" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "productConfiguratorSettings": { "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" } }, "orderLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "cmsBlocks": { "type": "array", "items": { "$ref": "#/components/schemas/CmsBlock" } }, "cmsSections": { "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "cmsPages": { "type": "array", "items": { "$ref": "#/components/schemas/CmsPage" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "a11yDocuments": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "appPaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "appShippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/AppShippingMethod" } } }, "type": "object" }, "MediaAiTagJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "needsAnalysis": { "type": "boolean", "readOnly": true }, "errorCode": { "type": "integer", "format": "int64" }, "tags": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/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" } ] }, "MediaAiTag": { "required": ["id", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "needsAnalysis": { "type": "boolean", "readOnly": true }, "errorCode": { "type": "integer", "format": "int64" }, "tags": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "MediaDefaultFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "entity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "folder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": ["id", "entity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "folder": { "$ref": "#/components/schemas/MediaFolder" } }, "type": "object" }, "MediaFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "configurationId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { "type": "boolean" }, "configurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "path": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "defaultFolder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_default_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "251dcc9b1621d34e6b01ee14c26b3027" } } } }, "type": "object" }, "configuration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder_configuration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ccd1066343c95877b75b79d47c36bebe" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": ["id", "configurationId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { "type": "boolean" }, "configurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "path": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "parent": { "$ref": "#/components/schemas/MediaFolder" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "defaultFolder": { "$ref": "#/components/schemas/MediaDefaultFolder" }, "configuration": { "$ref": "#/components/schemas/MediaFolderConfiguration" } }, "type": "object" }, "MediaFolderConfigurationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { "type": "boolean" }, "keepAspectRatio": { "type": "boolean" }, "thumbnailQuality": { "type": "integer", "format": "int64" }, "private": { "type": "boolean" }, "noAssociation": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "mediaFolders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder" }, "id": { "type": "string", "example": "6e8238687513bde2e85821c839c597c6" } } } } }, "type": "object" }, "mediaThumbnailSizes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_thumbnail_size" }, "id": { "type": "string", "example": "44dee48a0006e8db2fcec2a5e1456449" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { "type": "boolean" }, "keepAspectRatio": { "type": "boolean" }, "thumbnailQuality": { "type": "integer", "format": "int64" }, "private": { "type": "boolean" }, "noAssociation": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "mediaFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolder" } }, "mediaThumbnailSizes": { "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnailSize" } } }, "type": "object" }, "MediaFolderConfigurationMediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": ["mediaFolderConfigurationId", "mediaThumbnailSizeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderConfigurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderConfiguration": { "$ref": "#/components/schemas/MediaFolderConfiguration" }, "mediaThumbnailSize": { "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" }, "MediaTag": { "description": "Added since version: 6.0.0.0", "required": ["mediaId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "media": { "$ref": "#/components/schemas/Media" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "MediaThumbnailJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "mediaId", "width", "height"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { "type": "integer", "format": "int64", "readOnly": true }, "height": { "type": "integer", "format": "int64", "readOnly": true }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "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": ["url", "mediaId", "width", "height"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { "type": "integer", "format": "int64", "readOnly": true }, "height": { "type": "integer", "format": "int64", "readOnly": true }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "media": { "$ref": "#/components/schemas/Media" }, "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": { "type": "integer", "format": "int64" }, "height": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "mediaFolderConfigurations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media_folder_configuration" }, "id": { "type": "string", "example": "056df7a700173d83ebb685b1a890f09b" } } } } }, "type": "object" }, "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}$" }, "width": { "type": "integer", "format": "int64" }, "height": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "mediaFolderConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } }, "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": { "type": "string" }, "title": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "street": { "type": "string" }, "status": { "type": "string" }, "hash": { "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { "type": "string", "format": "date-time" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ "id", "email", "status", "hash", "languageId", "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "type": "string" }, "title": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "zipCode": { "type": "string" }, "city": { "type": "string" }, "street": { "type": "string" }, "status": { "type": "string" }, "hash": { "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { "type": "string", "format": "date-time" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "salutation": { "$ref": "#/components/schemas/Salutation" }, "language": { "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "NewsletterRecipientTag": { "description": "Added since version: 6.0.0.0", "required": ["newsletterRecipientId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "newsletterRecipientId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "newsletterRecipient": { "$ref": "#/components/schemas/NewsletterRecipient" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "NotificationJsonApi": { "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "status", "message"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "status": { "type": "string" }, "message": { "type": "string" }, "adminOnly": { "type": "boolean" }, "requiredPrivileges": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdByIntegrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "createdByIntegration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "4698501400b26be8a41def09646e1b59" } } } }, "type": "object" }, "createdByUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8a66af2fd5b68899934d19e078c9c111" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Notification": { "description": "Added since version: 6.4.7.0", "required": ["id", "status", "message"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "status": { "type": "string" }, "message": { "type": "string" }, "adminOnly": { "type": "boolean" }, "requiredPrivileges": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdByIntegrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "createdByIntegration": { "$ref": "#/components/schemas/Integration" }, "createdByUser": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "NumberRangeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "typeId", "global", "pattern", "start", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "typeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "pattern": { "type": "string" }, "start": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "type": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, "numberRangeSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_sales_channel" }, "id": { "type": "string", "example": "62db021f1d56ae4688775365be68a04f" } } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRange": { "description": "Added since version: 6.0.0.0", "required": ["id", "typeId", "global", "pattern", "start", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "typeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "pattern": { "type": "string" }, "start": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "type": { "$ref": "#/components/schemas/NumberRangeType" }, "numberRangeSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } }, "state": { "$ref": "#/components/schemas/NumberRangeState" } }, "type": "object" }, "NumberRangeSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "numberRangeId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "numberRange": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "numberRangeType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3d771a402fc5aa3349c2c15637058e8c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": ["id", "numberRangeId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "numberRange": { "$ref": "#/components/schemas/NumberRange" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "numberRangeType": { "$ref": "#/components/schemas/NumberRangeType" } }, "type": "object" }, "NumberRangeStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "numberRangeId", "lastValue"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastValue": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "numberRange": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRangeState": { "description": "Added since version: 6.0.0.0", "required": ["id", "numberRangeId", "lastValue"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastValue": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "numberRange": { "$ref": "#/components/schemas/NumberRange" } }, "type": "object" }, "NumberRangeTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "global", "typeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "typeName": { "type": "string" }, "global": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "numberRanges": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range" }, "id": { "type": "string", "example": "d28d88efea70a67487116019cff39002" } } } } }, "type": "object" }, "numberRangeSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "number_range_sales_channel" }, "id": { "type": "string", "example": "62db021f1d56ae4688775365be68a04f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": ["id", "global", "typeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "typeName": { "type": "string" }, "global": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "numberRanges": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRange" } }, "numberRangeSalesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/NumberRangeSalesChannel" } } }, "type": "object" }, "OrderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "billingAddressId", "currencyId", "languageId", "salesChannelId", "orderDateTime", "currencyFactor", "stateId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "orderNumber": { "type": "string" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { "type": "string", "format": "date-time" }, "orderDate": { "type": "string", "readOnly": true }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "positionPrice": { "type": "number", "format": "float", "readOnly": true }, "taxStatus": { "type": "string", "readOnly": true }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "shippingTotal": { "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { "type": "number", "format": "float" }, "deepLinkCode": { "type": "string" }, "affiliateCode": { "type": "string" }, "campaignCode": { "type": "string" }, "customerComment": { "type": "string" }, "internalComment": { "type": "string" }, "source": { "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, "initialSubscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "3b40c275cdd1f84402bcef5be1651f64" } } } } }, "type": "object" }, "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "warehouseGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_warehouse_group" }, "id": { "type": "string", "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } } } }, "type": "object" }, "warehouseProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_product_warehouse" }, "id": { "type": "string", "example": "702258c6879958a41dfc328ad5c00325" } } } } }, "type": "object" }, "returns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "7fff84525c6516919851a9005373f87e" } } } } }, "type": "object" }, "orderEmployee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_order_employee" }, "id": { "type": "string", "example": "5ea451c08a87db806089c4031601c29a" } } } } }, "type": "object" }, "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "b2bPendingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "c7e0572188e2dec59215e8872024567e" } } } } }, "type": "object" }, "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, "swagSocialShoppingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/swagSocialShoppingOrder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "829fa9441f5dea1e7ada99a9ae4a867f" } } } }, "type": "object" }, "budget": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2f212049ce79d2b949fd242043004288" } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "orderNumber": { "type": "string" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { "type": "string", "format": "date-time" }, "orderDate": { "type": "string", "readOnly": true }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "positionPrice": { "type": "number", "format": "float", "readOnly": true }, "taxStatus": { "type": "string", "readOnly": true }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "shippingTotal": { "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { "type": "number", "format": "float" }, "deepLinkCode": { "type": "string" }, "affiliateCode": { "type": "string" }, "campaignCode": { "type": "string" }, "customerComment": { "type": "string" }, "internalComment": { "type": "string" }, "source": { "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, "initialSubscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "3b40c275cdd1f84402bcef5be1651f64" } } } } }, "type": "object" }, "delayActions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_delay_action" }, "id": { "type": "string", "example": "edfed55799054673006c4b5a643489ac" } } } } }, "type": "object" }, "warehouseGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_warehouse_group" }, "id": { "type": "string", "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } } } }, "type": "object" }, "warehouseProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_product_warehouse" }, "id": { "type": "string", "example": "702258c6879958a41dfc328ad5c00325" } } } } }, "type": "object" }, "returns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "7fff84525c6516919851a9005373f87e" } } } } }, "type": "object" }, "orderEmployee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_order_employee" }, "id": { "type": "string", "example": "5ea451c08a87db806089c4031601c29a" } } } } }, "type": "object" }, "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "b2bPendingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "c7e0572188e2dec59215e8872024567e" } } } } }, "type": "object" }, "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, "swagSocialShoppingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/swagSocialShoppingOrder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "829fa9441f5dea1e7ada99a9ae4a867f" } } } }, "type": "object" }, "budget": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_budget" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2f212049ce79d2b949fd242043004288" } } } }, "type": "object" } }, "type": "object" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "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": { "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "countryState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "orderDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/orderDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "0ba472de56dd7ba2e7bb878434321e26" } } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", "countryId", "orderId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "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 }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "order": { "$ref": "#/components/schemas/Order" }, "orderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "OrderCustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderId", "email", "firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "type": "string" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "vatIds": { "type": "array", "items": { "type": "string" } }, "customerNumber": { "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": ["id", "orderId", "email", "firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "type": "string" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "vatIds": { "type": "array", "items": { "type": "string" } }, "customerNumber": { "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "customer": { "$ref": "#/components/schemas/Customer" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "OrderDeliveryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "shippingOrderAddressId", "shippingMethodId", "stateId", "shippingDateEarliest", "shippingDateLatest" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingCodes": { "type": "array", "items": { "type": "string" } }, "shippingDateEarliest": { "type": "string", "format": "date-time" }, "shippingDateLatest": { "type": "string", "format": "date-time" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingCodes": { "type": "array", "items": { "type": "string" } }, "shippingDateEarliest": { "type": "string", "format": "date-time" }, "shippingDateLatest": { "type": "string", "format": "date-time" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderDelivery": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "473c50bdac32ac0dc66364d121260dce" } } } }, "type": "object" }, "orderLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": ["id", "orderDeliveryId", "orderLineItemId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderDelivery": { "$ref": "#/components/schemas/OrderDelivery" }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, "OrderLineItemJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "identifier", "quantity", "label", "states", "price", "children" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "referencedId": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "payload": { "type": "object" }, "good": { "type": "boolean" }, "removable": { "type": "boolean" }, "stackable": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "states": { "type": "array", "items": { "type": "string" } }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "priceDefinition": { "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "description": { "type": "string" }, "type": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "returns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "7fff84525c6516919851a9005373f87e" } } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "cover": { "description": "Line item image or thumbnail", "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", "states", "price", "children" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "referencedId": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "label": { "type": "string" }, "payload": { "type": "object" }, "good": { "type": "boolean" }, "removable": { "type": "boolean" }, "stackable": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "states": { "type": "array", "items": { "type": "string" } }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "priceDefinition": { "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "description": { "type": "string" }, "type": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "returns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "7fff84525c6516919851a9005373f87e" } } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" } }, "type": "object" }, "cover": { "$ref": "#/components/schemas/Media", "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "accessGranted": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderLineItemDownload": { "description": "Added since version: 6.4.19.0", "required": [ "id", "orderLineItemId", "mediaId", "position", "accessGranted" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "accessGranted": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "OrderProductWarehouseJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderId", "productId", "warehouseId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantity": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "warehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse" }, "id": { "type": "string", "example": "544959798565126142ca2820b4f56271" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderProductWarehouse": { "required": ["id", "orderId", "productId", "warehouseId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantity": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "product": { "$ref": "#/components/schemas/Product" }, "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } }, "type": "object" }, "OrderReturnJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "stateId", "returnNumber", "requestedAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "returnNumber": { "type": "string" }, "requestedAt": { "type": "string", "format": "date-time" }, "amountTotal": { "type": "number", "format": "float" }, "amountNet": { "type": "number", "format": "float" }, "internalComment": { "type": "string" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, "updatedBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, "lineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderReturn": { "required": ["id", "orderId", "stateId", "returnNumber", "requestedAt"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "returnNumber": { "type": "string" }, "requestedAt": { "type": "string", "format": "date-time" }, "amountTotal": { "type": "number", "format": "float" }, "amountNet": { "type": "number", "format": "float" }, "internalComment": { "type": "string" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "state": { "$ref": "#/components/schemas/StateMachineState" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } }, "type": "object" }, "OrderReturnLineItemJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderReturnId", "orderLineItemId", "reasonId", "quantity", "price", "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderReturnId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderReturnVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reasonId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantity": { "type": "integer", "format": "int64" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "refundAmount": { "type": "number", "format": "float" }, "restockQuantity": { "type": "integer", "format": "int64" }, "internalComment": { "type": "string" }, "customFields": { "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "reason": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item_reason" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "40bea8d637cdf2c1b07fcf0630482b73" } } } }, "type": "object" }, "state": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" }, "return": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" } } } }, "type": "object" }, "lineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "867cf1ff92974922abc5d5b045b4a2d8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderReturnLineItem": { "required": [ "id", "orderReturnId", "orderLineItemId", "reasonId", "quantity", "price", "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderReturnId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderReturnVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reasonId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantity": { "type": "integer", "format": "int64" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "refundAmount": { "type": "number", "format": "float" }, "restockQuantity": { "type": "integer", "format": "int64" }, "internalComment": { "type": "string" }, "customFields": { "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "reason": { "$ref": "#/components/schemas/OrderReturnLineItemReason" }, "state": { "$ref": "#/components/schemas/StateMachineState" }, "return": { "$ref": "#/components/schemas/OrderReturn" }, "lineItem": { "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, "OrderReturnLineItemReasonJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "reasonKey", "content"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reasonKey": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "lineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderReturnLineItemReason": { "required": ["id", "reasonKey", "content"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "reasonKey": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderReturnLineItem" } } }, "type": "object" }, "OrderTag": { "description": "Added since version: 6.0.0.0", "required": ["orderId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "order": { "$ref": "#/components/schemas/Order" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "OrderTransactionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "orderId", "paymentMethodId", "amount", "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "validationData": { "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "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}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "validationData": { "type": "object" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState", "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod", "description": "Payment method used for this transaction" }, "captures": { "description": "Payment captures for this transaction", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } }, "primaryOrder": { "$ref": "#/components/schemas/Order" } }, "type": "object" }, "OrderTransactionCaptureJsonApi": { "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderTransactionId", "stateId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "transaction": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, "refunds": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "example": "0084ff716402199f733f841f5937d3ae" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCapture": { "description": "Added since version: 6.4.12.0", "required": ["id", "orderTransactionId", "stateId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "transaction": { "$ref": "#/components/schemas/OrderTransaction" }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } }, "type": "object" }, "OrderTransactionCaptureRefundJsonApi": { "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "captureId", "stateId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "captureId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "captureVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "reason": { "type": "string" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "transactionCapture": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "56b70ce76ce8e9bfbaf80ea040d456b5" } } } }, "type": "object" }, "positions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCaptureRefund": { "description": "Added since version: 6.4.12.0", "required": ["id", "captureId", "stateId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "captureId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "captureVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "reason": { "type": "string" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "transactionCapture": { "$ref": "#/components/schemas/OrderTransactionCapture" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } }, "type": "object" }, "OrderTransactionCaptureRefundPositionJsonApi": { "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "refundId", "orderLineItemId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "reason": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8e55f83da36c39263717541ec1f18de7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderTransactionCaptureRefundPosition": { "description": "Added since version: 6.4.12.0", "required": ["id", "refundId", "orderLineItemId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { "type": "string" }, "reason": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderLineItem": { "$ref": "#/components/schemas/OrderLineItem" }, "orderTransactionCaptureRefund": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "type": "object" }, "OrderWarehouseGroupJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderId", "warehouseGroupId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "warehouseGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1768e3071b62161d415e0c24332055ed" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "OrderWarehouseGroup": { "required": ["id", "orderId", "warehouseGroupId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "order": { "$ref": "#/components/schemas/Order" }, "warehouseGroup": { "$ref": "#/components/schemas/WarehouseGroup" } }, "type": "object" }, "PaymentMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { "type": "string" }, "name": { "type": "string" }, "distinguishableName": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "afterOrderEnabled": { "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "formattedHandlerIdentifier": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "technicalName": { "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quoteTransactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_transaction" }, "id": { "type": "string", "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } } }, "type": "object" }, "organizations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "d9811f03b461a380c0d6b4a497dbac37" } } } } }, "type": "object" }, "paypalVaultTokens": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/paypalVaultTokens" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token" }, "id": { "type": "string", "example": "7e423eeb595163d20591951433de150c" } } } } }, "type": "object" }, "paypalVaultTokenMappings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/paypalVaultTokenMappings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token_mapping" }, "id": { "type": "string", "example": "75fb7d13a771c74947402295ed591499" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { "type": "string" }, "name": { "type": "string" }, "distinguishableName": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "afterOrderEnabled": { "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "formattedHandlerIdentifier": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "technicalName": { "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quoteTransactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_transaction" }, "id": { "type": "string", "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } } }, "type": "object" }, "organizations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "d9811f03b461a380c0d6b4a497dbac37" } } } } }, "type": "object" }, "paypalVaultTokens": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/paypalVaultTokens" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token" }, "id": { "type": "string", "example": "7e423eeb595163d20591951433de150c" } } } } }, "type": "object" }, "paypalVaultTokenMappings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/paypalVaultTokenMappings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token_mapping" }, "id": { "type": "string", "example": "75fb7d13a771c74947402295ed591499" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "media": { "$ref": "#/components/schemas/Media", "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "salesChannelDefaultAssignments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "plugin": { "$ref": "#/components/schemas/Plugin" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orderTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "appPaymentMethod": { "$ref": "#/components/schemas/AppPaymentMethod" } }, "type": "object" }, "PluginJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "baseClass", "name", "autoload", "version", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "baseClass": { "type": "string" }, "name": { "type": "string" }, "composerName": { "type": "string" }, "autoload": { "type": "object" }, "active": { "type": "boolean" }, "managedByComposer": { "type": "boolean" }, "path": { "type": "string" }, "author": { "type": "string" }, "copyright": { "type": "string" }, "license": { "type": "string" }, "version": { "type": "string" }, "upgradeVersion": { "type": "string" }, "installedAt": { "type": "string", "format": "date-time" }, "upgradedAt": { "type": "string", "format": "date-time" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "label": { "type": "string" }, "description": { "type": "string" }, "manufacturerLink": { "type": "string" }, "supportLink": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Plugin": { "description": "Added since version: 6.0.0.0", "required": ["id", "baseClass", "name", "autoload", "version", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "baseClass": { "type": "string" }, "name": { "type": "string" }, "composerName": { "type": "string" }, "autoload": { "type": "object" }, "active": { "type": "boolean" }, "managedByComposer": { "type": "boolean" }, "path": { "type": "string" }, "author": { "type": "string" }, "copyright": { "type": "string" }, "license": { "type": "string" }, "version": { "type": "string" }, "upgradeVersion": { "type": "string" }, "installedAt": { "type": "string", "format": "date-time" }, "upgradedAt": { "type": "string", "format": "date-time" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, "label": { "type": "string" }, "description": { "type": "string" }, "manufacturerLink": { "type": "string" }, "supportLink": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "type": "object" }, "ProductJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "taxId", "price", "productNumber", "stock", "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productManufacturerVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productMediaVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "productNumber": { "type": "string" }, "restockTime": { "type": "integer", "format": "int64" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "active": { "type": "boolean" }, "available": { "type": "boolean", "readOnly": true }, "isCloseout": { "type": "boolean" }, "availableStock": { "type": "integer", "format": "int64", "readOnly": true }, "stock": { "type": "integer", "format": "int64" }, "variation": { "type": "array", "items": { "type": "string" } }, "displayGroup": { "type": "string", "readOnly": true }, "variantListingConfig": { "type": "object" }, "variantRestrictions": { "type": "object" }, "manufacturerNumber": { "type": "string" }, "ean": { "type": "string" }, "purchaseSteps": { "type": "integer", "format": "int64" }, "maxPurchase": { "type": "integer", "format": "int64" }, "minPurchase": { "type": "integer", "format": "int64" }, "purchaseUnit": { "type": "number", "format": "float" }, "referenceUnit": { "type": "number", "format": "float" }, "shippingFree": { "type": "boolean" }, "purchasePrices": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "markAsTopseller": { "type": "boolean" }, "weight": { "type": "number", "format": "float" }, "width": { "type": "number", "format": "float" }, "height": { "type": "number", "format": "float" }, "length": { "type": "number", "format": "float" }, "releaseDate": { "type": "string", "format": "date-time" }, "ratingAverage": { "type": "number", "format": "float", "readOnly": true }, "categoryTree": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "propertyIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "optionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "streamIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "categoryIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "customFieldSetSelectionActive": { "type": "boolean" }, "sales": { "type": "integer", "format": "int64", "readOnly": true }, "states": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "metaDescription": { "type": "string" }, "name": { "type": "string" }, "keywords": { "type": "string" }, "description": { "type": "string" }, "metaTitle": { "type": "string" }, "packUnit": { "type": "string" }, "packUnitPlural": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "customSearchKeywords": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" }, "subscriptionPlans": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" }, "warehouseGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } } } }, "type": "object" }, "warehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/warehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_warehouse" }, "id": { "type": "string", "example": "544959798565126142ca2820b4f56271" } } } } }, "type": "object" }, "orderWarehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_product_warehouse" }, "id": { "type": "string", "example": "5331369e2f71d048521bd35d80975314" } } } } }, "type": "object" }, "reviewSummaries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review_summary" }, "id": { "type": "string", "example": "c9c718522e64ffa5effb26cef94f4849" } } } } }, "type": "object" }, "search": { "type": "object" }, "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" }, "shoppingListLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", "example": "ce593c6d1db236f22dc387a2ee20dfd6" } } } } }, "type": "object" }, "swagCustomizedProductsTemplate": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/swagCustomizedProductsTemplate" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6e9fad30dd3cb84748a01bb8152f4769" } } } }, "type": "object" }, "attendeeProductCollections": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_attendee_product_collection" }, "id": { "type": "string", "example": "0a7b3b2f4b81f36910a74f22826f35df" } } } } }, "type": "object" }, "presentationCmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_cms_page" }, "id": { "type": "string", "example": "30c725082807b69914fddd7e82d0d741" } } } } }, "type": "object" }, "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" }, "paypalPosLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/paypalPosLog" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_run_log" }, "id": { "type": "string", "example": "7edfbc8f7a12c1d79b6de5b0154cf325" } } } } }, "type": "object" }, "paypalPosSync": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/paypalPosSync" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_product" }, "id": { "type": "string", "example": "163c806e836f72f29f292c8ef2dfe61e" } } } } }, "type": "object" }, "socialShoppingProductErrors": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/socialShoppingProductErrors" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_product_error" }, "id": { "type": "string", "example": "74181afcb28901351a5f2676d1687de8" } } } } }, "type": "object" }, "employeeWishlists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", "example": "e91afc4e24376c8b995cece3ce354b4e" } } } } }, "type": "object" } }, "type": "object" }, "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": { "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" }, "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" }, { "$ref": "#/components/schemas/DiscountLineItemPayload" } ] }, "Product": { "description": "Added since version: 6.0.0.0", "required": ["id", "taxId", "price", "productNumber", "stock", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productManufacturerVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productMediaVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "productNumber": { "type": "string" }, "restockTime": { "type": "integer", "format": "int64" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "active": { "type": "boolean" }, "available": { "type": "boolean", "readOnly": true }, "isCloseout": { "type": "boolean" }, "availableStock": { "type": "integer", "format": "int64", "readOnly": true }, "stock": { "type": "integer", "format": "int64" }, "variation": { "type": "array", "items": { "type": "string" } }, "displayGroup": { "type": "string", "readOnly": true }, "variantListingConfig": { "type": "object" }, "variantRestrictions": { "type": "object" }, "manufacturerNumber": { "type": "string" }, "ean": { "type": "string" }, "purchaseSteps": { "type": "integer", "format": "int64" }, "maxPurchase": { "type": "integer", "format": "int64" }, "minPurchase": { "type": "integer", "format": "int64" }, "purchaseUnit": { "type": "number", "format": "float" }, "referenceUnit": { "type": "number", "format": "float" }, "shippingFree": { "type": "boolean" }, "purchasePrices": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "markAsTopseller": { "type": "boolean" }, "weight": { "type": "number", "format": "float" }, "width": { "type": "number", "format": "float" }, "height": { "type": "number", "format": "float" }, "length": { "type": "number", "format": "float" }, "releaseDate": { "type": "string", "format": "date-time" }, "ratingAverage": { "type": "number", "format": "float", "readOnly": true }, "categoryTree": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "propertyIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "optionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "streamIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "categoryIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "childCount": { "type": "integer", "format": "int64", "readOnly": true }, "customFieldSetSelectionActive": { "type": "boolean" }, "sales": { "type": "integer", "format": "int64", "readOnly": true }, "states": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "metaDescription": { "type": "string" }, "name": { "type": "string" }, "keywords": { "type": "string" }, "description": { "type": "string" }, "metaTitle": { "type": "string" }, "packUnit": { "type": "string" }, "packUnitPlural": { "type": "string" }, "customFields": { "type": "object" }, "slotConfig": { "type": "object" }, "customSearchKeywords": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "customPrice": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/customPrice" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_price" }, "id": { "type": "string", "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" }, "subscriptionPlans": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" }, "warehouseGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } } } }, "type": "object" }, "warehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/warehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_warehouse" }, "id": { "type": "string", "example": "544959798565126142ca2820b4f56271" } } } } }, "type": "object" }, "orderWarehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_product_warehouse" }, "id": { "type": "string", "example": "5331369e2f71d048521bd35d80975314" } } } } }, "type": "object" }, "reviewSummaries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_review_summary" }, "id": { "type": "string", "example": "c9c718522e64ffa5effb26cef94f4849" } } } } }, "type": "object" }, "search": { "type": "object" }, "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" }, "shoppingListLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", "example": "ce593c6d1db236f22dc387a2ee20dfd6" } } } } }, "type": "object" }, "swagCustomizedProductsTemplate": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/swagCustomizedProductsTemplate" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6e9fad30dd3cb84748a01bb8152f4769" } } } }, "type": "object" }, "attendeeProductCollections": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_attendee_product_collection" }, "id": { "type": "string", "example": "0a7b3b2f4b81f36910a74f22826f35df" } } } } }, "type": "object" }, "presentationCmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_cms_page" }, "id": { "type": "string", "example": "30c725082807b69914fddd7e82d0d741" } } } } }, "type": "object" }, "swagDynamicAccessRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/swagDynamicAccessRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "05b9d828254c957dfa5224c581439c92" } } } } }, "type": "object" }, "paypalPosLog": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/paypalPosLog" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_run_log" }, "id": { "type": "string", "example": "7edfbc8f7a12c1d79b6de5b0154cf325" } } } } }, "type": "object" }, "paypalPosSync": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/paypalPosSync" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_product" }, "id": { "type": "string", "example": "163c806e836f72f29f292c8ef2dfe61e" } } } } }, "type": "object" }, "socialShoppingProductErrors": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/socialShoppingProductErrors" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_product_error" }, "id": { "type": "string", "example": "74181afcb28901351a5f2676d1687de8" } } } } }, "type": "object" }, "employeeWishlists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_employee_wishlist_product" }, "id": { "type": "string", "example": "e91afc4e24376c8b995cece3ce354b4e" } } } } }, "type": "object" } }, "type": "object" }, "downloads": { "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { "$ref": "#/components/schemas/Product" }, "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" }, "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}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" } }, "type": "object" }, "ProductCategoryTree": { "description": "Added since version: 6.0.0.0", "required": ["productId", "categoryId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" } }, "type": "object" }, "ProductConfiguratorSettingJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "optionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "option": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/option" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ef3e30e070f70244fd6578d88a6b77ac" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", "required": ["id", "productId", "optionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductCrossSellingJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "productId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "sortBy": { "type": "string" }, "sortDirection": { "type": "string" }, "type": { "type": "string" }, "active": { "type": "boolean" }, "limit": { "type": "integer", "format": "int64" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "assignedProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling_assigned_products" }, "id": { "type": "string", "example": "5da5e10eda1b7026499bcd4747d6bdf8" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductCrossSelling": { "description": "Added since version: 6.1.0.0", "required": ["id", "name", "productId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "sortBy": { "type": "string" }, "sortDirection": { "type": "string" }, "type": { "type": "string" }, "active": { "type": "boolean" }, "limit": { "type": "integer", "format": "int64" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "product": { "$ref": "#/components/schemas/Product" }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "assignedProducts": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } }, "type": "object" }, "ProductCrossSellingAssignedProductsJsonApi": { "description": "Added since version: 6.2.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "crossSellingId", "productId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "crossSelling": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ef23268669fb6d8a7def2b9f2da0aceb" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductCrossSellingAssignedProducts": { "description": "Added since version: 6.2.0.0", "required": ["id", "crossSellingId", "productId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "crossSelling": { "$ref": "#/components/schemas/ProductCrossSelling" } }, "type": "object" }, "ProductCustomFieldSet": { "description": "Added since version: 6.3.0.0", "required": ["productId", "customFieldSetId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "customFieldSet": { "$ref": "#/components/schemas/CustomFieldSet" } }, "type": "object" }, "ProductDownloadJsonApi": { "description": "Added since version: 6.4.19.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductDownload": { "description": "Added since version: 6.4.19.0", "required": ["id", "productId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "ProductExportJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", "salesChannelDomainId", "currencyId", "fileName", "accessKey", "encoding", "fileFormat", "generateByCronjob", "interval" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { "type": "string" }, "accessKey": { "type": "string" }, "encoding": { "type": "string" }, "fileFormat": { "type": "string" }, "includeVariants": { "type": "boolean" }, "generateByCronjob": { "type": "boolean" }, "generatedAt": { "type": "string", "format": "date-time" }, "interval": { "type": "integer", "format": "int64" }, "headerTemplate": { "type": "string" }, "bodyTemplate": { "type": "string" }, "footerTemplate": { "type": "string" }, "pausedSchedule": { "type": "boolean" }, "isRunning": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "storefrontSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/storefrontSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5979d6e259ba5ec4c2b93cf79df6f2e5" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "salesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannelDomain" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "29c8b34b04e94e35e95e8346954b7fb4" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductExport": { "description": "Added since version: 6.1.0.0", "required": [ "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", "salesChannelDomainId", "currencyId", "fileName", "accessKey", "encoding", "fileFormat", "generateByCronjob", "interval" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { "type": "string" }, "accessKey": { "type": "string" }, "encoding": { "type": "string" }, "fileFormat": { "type": "string" }, "includeVariants": { "type": "boolean" }, "generateByCronjob": { "type": "boolean" }, "generatedAt": { "type": "string", "format": "date-time" }, "interval": { "type": "integer", "format": "int64" }, "headerTemplate": { "type": "string" }, "bodyTemplate": { "type": "string" }, "footerTemplate": { "type": "string" }, "pausedSchedule": { "type": "boolean" }, "isRunning": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "storefrontSalesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "salesChannelDomain": { "$ref": "#/components/schemas/SalesChannelDomain" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "ProductFeatureSetJsonApi": { "description": "Added since version: 6.3.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-feature-set/69d445ae065ef917cd50febab4b55db2/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductFeatureSet": { "description": "Added since version: 6.3.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "features": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductKeywordDictionaryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "languageId", "keyword"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "type": "string" }, "reversed": { "type": "string" }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-keyword-dictionary/a1bc4695aa3e6f80fb42d62e6439296c/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductKeywordDictionary": { "description": "Added since version: 6.0.0.0", "required": ["id", "languageId", "keyword"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "type": "string" }, "reversed": { "type": "string" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductManufacturerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "link": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "search": { "type": "object" } }, "type": "object" }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductManufacturer": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "link": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "search": { "type": "object" } }, "type": "object" }, "media": { "$ref": "#/components/schemas/Media" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "ProductMediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "coverProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductMedia": { "description": "Added since version: 6.0.0.0", "required": ["id", "productId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "media": { "$ref": "#/components/schemas/Media" }, "coverProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "thumbnails": { "$ref": "#/components/schemas/MediaThumbnail" } }, "type": "object" }, "ProductOption": { "description": "Added since version: 6.0.0.0", "required": ["productId", "optionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductPriceJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "ruleId", "price", "quantityStart"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantityStart": { "type": "integer", "format": "int64" }, "quantityEnd": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductPrice": { "description": "Added since version: 6.0.0.0", "required": ["id", "productId", "ruleId", "price", "quantityStart"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "quantityStart": { "type": "integer", "format": "int64" }, "quantityEnd": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "ProductProperty": { "description": "Added since version: 6.0.0.0", "required": ["productId", "optionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "option": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, "ProductReviewJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "productId", "salesChannelId", "languageId", "title", "content" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { "type": "string" }, "externalEmail": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "points": { "type": "number", "format": "float" }, "status": { "type": "boolean" }, "comment": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductReview": { "description": "Added since version: 6.0.0.0", "required": [ "id", "productId", "salesChannelId", "languageId", "title", "content" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { "type": "string" }, "externalEmail": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "points": { "type": "number", "format": "float" }, "status": { "type": "boolean" }, "comment": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "customer": { "$ref": "#/components/schemas/Customer" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductReviewSummaryJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "summary": { "type": "string" }, "visible": { "type": "boolean" }, "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-review-summary/a4b5dac1755dd11ea772509278bbc072/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-review-summary/a4b5dac1755dd11ea772509278bbc072/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" } ] }, "ProductReviewSummary": { "required": ["id", "productId", "salesChannelId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "summary": { "type": "string" }, "visible": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "product": { "$ref": "#/components/schemas/Product" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "ProductSearchConfigJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "languageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { "type": "boolean" }, "minSearchLength": { "type": "integer", "format": "int64" }, "excludedTerms": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "configFields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config_field" }, "id": { "type": "string", "example": "5334117da647d3f2fb8a82948d56bcc3" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchConfig": { "description": "Added since version: 6.3.5.0", "required": ["id", "languageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { "type": "boolean" }, "minSearchLength": { "type": "integer", "format": "int64" }, "excludedTerms": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" }, "configFields": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSearchConfigField" } } }, "type": "object" }, "ProductSearchConfigFieldJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "searchConfigId", "field"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { "type": "string" }, "tokenize": { "type": "boolean" }, "searchable": { "type": "boolean" }, "ranking": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "searchConfig": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bc8281d44069ce8ffd34144fbad1bddd" } } } }, "type": "object" }, "customField": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "custom_field" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ed2028a1c479c7e0065da597452d9c11" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchConfigField": { "description": "Added since version: 6.3.5.0", "required": ["id", "searchConfigId", "field"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { "type": "string" }, "tokenize": { "type": "boolean" }, "searchable": { "type": "boolean" }, "ranking": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "searchConfig": { "$ref": "#/components/schemas/ProductSearchConfig" }, "customField": { "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, "ProductSearchKeywordJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "languageId", "productId", "keyword", "ranking"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "type": "string" }, "ranking": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", "required": ["id", "languageId", "productId", "keyword", "ranking"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { "type": "string" }, "ranking": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "ProductSortingJsonApi": { "description": "Added since version: 6.3.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "key", "priority", "active", "fields", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "locked": { "type": "boolean" }, "key": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "fields": { "type": "object" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" } ] }, "ProductSorting": { "description": "Added since version: 6.3.2.0", "required": ["id", "key", "priority", "active", "fields", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "locked": { "type": "boolean" }, "key": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" }, "fields": { "type": "object" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" } }, "type": "object" }, "ProductStreamJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "apiFilter": { "type": "object", "readOnly": true }, "invalid": { "type": "boolean", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "presentationCmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_cms_page" }, "id": { "type": "string", "example": "30c725082807b69914fddd7e82d0d741" } } } } }, "type": "object" }, "paypalPosSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/paypalPosSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel" }, "id": { "type": "string", "example": "80dd7867f3205b7f1600d6c76438fb42" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "filters": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "example": "2c9885d2b0c7e26971f60a90f33cf718" } } } } }, "type": "object" }, "productCrossSellings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productCrossSellings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_cross_selling" }, "id": { "type": "string", "example": "6fa3de1d94218e2ac5a51cbeaca7f846" } } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductStream": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "apiFilter": { "type": "object", "readOnly": true }, "invalid": { "type": "boolean", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "presentationCmsPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation_cms_page" }, "id": { "type": "string", "example": "30c725082807b69914fddd7e82d0d741" } } } } }, "type": "object" }, "paypalPosSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/paypalPosSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel" }, "id": { "type": "string", "example": "80dd7867f3205b7f1600d6c76438fb42" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" } }, "type": "object" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } }, "productCrossSellings": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" } }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } }, "type": "object" }, "ProductStreamFilterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productStreamId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "parameters": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "queries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream_filter" }, "id": { "type": "string", "example": "5da7eb4247add5dbd5776c9c0b38460a" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", "required": ["id", "productStreamId", "type"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "parameters": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "parent": { "$ref": "#/components/schemas/ProductStreamFilter" }, "queries": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStreamFilter" } } }, "type": "object" }, "ProductStreamMapping": { "description": "Added since version: 6.4.0.0", "required": ["productId", "productStreamId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "productStream": { "$ref": "#/components/schemas/ProductStream" } }, "type": "object" }, "ProductTag": { "description": "Added since version: 6.0.0.0", "required": ["productId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "ProductVisibilityJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "salesChannelId", "visibility"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductVisibility": { "description": "Added since version: 6.0.0.0", "required": ["id", "productId", "salesChannelId", "visibility"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visibility": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "ProductWarehouseJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "warehouseId", "stock"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stock": { "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-warehouse/bb934215f15673b81755030f1d8cc000/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "warehouse": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/product-warehouse/bb934215f15673b81755030f1d8cc000/warehouse" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "372d30dd2849813ef674855253900679" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ProductWarehouse": { "required": ["id", "productId", "warehouseId", "stock"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stock": { "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" }, "warehouse": { "$ref": "#/components/schemas/Warehouse" } }, "type": "object" }, "ProductWarehouseGroup": { "required": ["productId", "warehouseGroupId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "warehouseGroup": { "$ref": "#/components/schemas/WarehouseGroup" }, "deliveryTime": { "$ref": "#/components/schemas/DeliveryTime" } }, "type": "object" }, "PromotionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int64" }, "exclusive": { "type": "boolean" }, "code": { "type": "string" }, "useCodes": { "type": "boolean" }, "useIndividualCodes": { "type": "boolean" }, "individualCodePattern": { "type": "string" }, "useSetGroups": { "type": "boolean" }, "customerRestriction": { "type": "boolean" }, "preventCombination": { "type": "boolean" }, "orderCount": { "type": "integer", "format": "int64", "readOnly": true }, "ordersPerCustomerCount": { "type": "object", "readOnly": true }, "exclusionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "setgroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/setgroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_setgroup" }, "id": { "type": "string", "example": "3c963571517f44e87274198cb8bb62a8" } } } } }, "type": "object" }, "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "discounts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "example": "9544fa2fae515081e7fc27ef2d268642" } } } } }, "type": "object" }, "individualCodes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/individualCodes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_individual_code" }, "id": { "type": "string", "example": "c777247035736c9eae54f8e5dfdcd2aa" } } } } }, "type": "object" }, "personaRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "382af96335a79de564c412e6b493d7f3" } } } } }, "type": "object" }, "personaCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "b969a9b0d5772d70ea83383c1be06c82" } } } } }, "type": "object" }, "orderRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "ee517f71bf240d98dcf33db6e6ffa881" } } } } }, "type": "object" }, "cartRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/cartRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "6549606ef529fde0a7628b4c0aa7c6ef" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Promotion": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "validFrom": { "type": "string", "format": "date-time" }, "validUntil": { "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int64" }, "exclusive": { "type": "boolean" }, "code": { "type": "string" }, "useCodes": { "type": "boolean" }, "useIndividualCodes": { "type": "boolean" }, "individualCodePattern": { "type": "string" }, "useSetGroups": { "type": "boolean" }, "customerRestriction": { "type": "boolean" }, "preventCombination": { "type": "boolean" }, "orderCount": { "type": "integer", "format": "int64", "readOnly": true }, "ordersPerCustomerCount": { "type": "object", "readOnly": true }, "exclusionIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "quoteLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" } }, "type": "object" }, "setgroups": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSalesChannel" } }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } }, "individualCodes": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionIndividualCode" } }, "personaRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "personaCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orderRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "cartRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "orderLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } } }, "type": "object" }, "PromotionCartRule": { "description": "Added since version: 6.0.0.0", "required": ["promotionId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionDiscountJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "promotionId", "scope", "type", "value"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "number", "format": "float" }, "considerAdvancedRules": { "type": "boolean" }, "maxValue": { "type": "number", "format": "float" }, "sorterKey": { "type": "string" }, "applierKey": { "type": "string" }, "usageKey": { "type": "string" }, "pickerKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "discountRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/discountRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "d5a1e52263eb12172f7657376d7622c8" } } } } }, "type": "object" }, "promotionDiscountPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotionDiscountPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount_prices" }, "id": { "type": "string", "example": "325723473ecab76b0f45e1554513f779" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionDiscount": { "description": "Added since version: 6.0.0.0", "required": ["id", "promotionId", "scope", "type", "value"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "number", "format": "float" }, "considerAdvancedRules": { "type": "boolean" }, "maxValue": { "type": "number", "format": "float" }, "sorterKey": { "type": "string" }, "applierKey": { "type": "string" }, "usageKey": { "type": "string" }, "pickerKey": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "discountRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } }, "promotionDiscountPrices": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscountPrices" } } }, "type": "object" }, "PromotionDiscountPricesJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "discountId", "currencyId", "price"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotionDiscount": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "eaeedb5c09dfc7dbf130657ed44ef33f" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionDiscountPrices": { "description": "Added since version: 6.0.0.0", "required": ["id", "discountId", "currencyId", "price"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotionDiscount": { "$ref": "#/components/schemas/PromotionDiscount" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "PromotionDiscountRule": { "description": "Added since version: 6.0.0.0", "required": ["discountId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discount": { "$ref": "#/components/schemas/PromotionDiscount" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionIndividualCodeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "promotionId", "code"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "type": "string" }, "payload": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", "required": ["id", "promotionId", "code"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { "type": "string" }, "payload": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" } }, "type": "object" }, "PromotionOrderRule": { "description": "Added since version: 6.0.0.0", "required": ["promotionId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionPersonaCustomer": { "description": "Added since version: 6.0.0.0", "required": ["promotionId", "customerId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "customer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "PromotionPersonaRule": { "description": "Added since version: 6.0.0.0", "required": ["promotionId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PromotionSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "promotionId", "salesChannelId", "priority"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", "required": ["id", "promotionId", "salesChannelId", "priority"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "PromotionSetgroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "promotionId", "packagerKey", "sorterKey", "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { "type": "string" }, "sorterKey": { "type": "string" }, "value": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "setGroupRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "a54c38d5a1d9180d689d11234afbbb32" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "required": ["id", "promotionId", "packagerKey", "sorterKey", "value"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { "type": "string" }, "sorterKey": { "type": "string" }, "value": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "setGroupRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } }, "type": "object" }, "PromotionSetgroupRule": { "description": "Added since version: 6.0.0.0", "required": ["setgroupId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "setgroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "setgroup": { "$ref": "#/components/schemas/PromotionSetgroup" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "PropertyGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayType": { "type": "string" }, "sortingType": { "type": "string" }, "filterable": { "type": "boolean" }, "visibleOnProductDetailPage": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "options": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "property_group_option" }, "id": { "type": "string", "example": "93da65a9fd0004d9477aeac024e08e15" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "PropertyGroup": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "displayType": { "type": "string" }, "sortingType": { "type": "string" }, "filterable": { "type": "boolean" }, "visibleOnProductDetailPage": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } } }, "type": "object" }, "PropertyGroupOptionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "groupId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "colorHexCode": { "type": "string" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "colorHexCode": { "type": "string" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, "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" }, "QuoteJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "stateId", "currencyId", "languageId", "salesChannelId", "customerId", "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 }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteNumber": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "discount": { "properties": { "type": { "type": "string" }, "value": { "type": "number", "format": "float" } }, "type": "object" }, "taxStatus": { "type": "string", "readOnly": true }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "subtotalNet": { "type": "number", "format": "float" }, "totalDiscount": { "type": "number", "format": "float" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/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": "/quote/c48e929b2b1eabba2ba036884433345e/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/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": "/quote/c48e929b2b1eabba2ba036884433345e/updatedBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7ced3d0067ad61702af7db8ae260aa76" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "order": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/order" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, "lineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/lineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } } }, "type": "object" }, "deliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/deliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery" }, "id": { "type": "string", "example": "6fc31b6b9cd717cc0dcb81152308f8af" } } } } }, "type": "object" }, "transactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/transactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_transaction" }, "id": { "type": "string", "example": "c15b977dd99332ca8623fbdfb86827e8" } } } } }, "type": "object" }, "comments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "a5d491060952aa8ad5fdee071be752de" } } } } }, "type": "object" }, "quoteEmployees": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/quoteEmployees" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_employee" }, "id": { "type": "string", "example": "2d59101091544ffd9a1d23090d6e2f0a" } } } } }, "type": "object" }, "documents": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/documents" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_document" }, "id": { "type": "string", "example": "21f64da1e5792c8295b964d159a14491" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Quote": { "description": "Added since version: 6.5.3.0", "required": [ "id", "stateId", "currencyId", "languageId", "salesChannelId", "customerId", "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 }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteNumber": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "price": { "required": [ "netPrice", "totalPrice", "positionPrice", "rawTotal", "taxStatus" ], "properties": { "netPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "positionPrice": { "type": "number", "format": "float" }, "rawTotal": { "type": "number", "format": "float" }, "taxStatus": { "type": "string" } }, "type": "object" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "discount": { "properties": { "type": { "type": "string" }, "value": { "type": "number", "format": "float" } }, "type": "object" }, "taxStatus": { "type": "string", "readOnly": true }, "amountTotal": { "type": "number", "format": "float", "readOnly": true }, "amountNet": { "type": "number", "format": "float", "readOnly": true }, "subtotalNet": { "type": "number", "format": "float" }, "totalDiscount": { "type": "number", "format": "float" }, "itemRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "totalRounding": { "required": ["decimals", "interval", "roundForNet"], "properties": { "decimals": { "type": "integer", "format": "int64" }, "interval": { "type": "number", "format": "float" }, "roundForNet": { "type": "boolean" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "organization": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" } }, "type": "object" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "user": { "$ref": "#/components/schemas/User" }, "currency": { "$ref": "#/components/schemas/Currency" }, "language": { "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "createdBy": { "$ref": "#/components/schemas/User" }, "updatedBy": { "$ref": "#/components/schemas/User" }, "customer": { "$ref": "#/components/schemas/Customer" }, "order": { "$ref": "#/components/schemas/Order" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDelivery" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteTransaction" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteComment" } }, "quoteEmployees": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteEmployee" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDocument" } } }, "type": "object" }, "QuoteCommentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "comment", "quoteId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "comment": { "type": "string" }, "seenAt": { "type": "string", "format": "date-time" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, "createdBy": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/createdBy" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteComment": { "required": ["id", "comment", "quoteId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "comment": { "type": "string" }, "seenAt": { "type": "string", "format": "date-time" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quote": { "$ref": "#/components/schemas/Quote" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "customer": { "$ref": "#/components/schemas/Customer" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" }, "createdBy": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "QuoteDeliveryJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "quoteId", "shippingMethodId", "shippingDateEarliest", "shippingDateLatest" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingDateEarliest": { "type": "string", "format": "date-time" }, "shippingDateLatest": { "type": "string", "format": "date-time" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "positions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/positions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery_position" }, "id": { "type": "string", "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteDelivery": { "description": "Added since version: 6.5.3.0", "required": [ "id", "quoteId", "shippingMethodId", "shippingDateEarliest", "shippingDateLatest" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingDateEarliest": { "type": "string", "format": "date-time" }, "shippingDateLatest": { "type": "string", "format": "date-time" }, "shippingCosts": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quote": { "$ref": "#/components/schemas/Quote" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } }, "type": "object" }, "QuoteDeliveryPositionJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "quoteDeliveryId", "quoteLineItemId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quoteDelivery": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteDelivery" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "19397469743ae5505500cb3fa99bc0b1" } } } }, "type": "object" }, "quoteLineItem": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteLineItem" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "dbe619b4a557266e76679178cc13085b" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteDeliveryPosition": { "description": "Added since version: 6.5.3.0", "required": ["id", "quoteDeliveryId", "quoteLineItemId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quoteDelivery": { "$ref": "#/components/schemas/QuoteDelivery" }, "quoteLineItem": { "$ref": "#/components/schemas/QuoteLineItem" } }, "type": "object" }, "QuoteDocumentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "documentTypeId", "fileType", "quoteId", "config", "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentNumber": { "type": "string" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileType": { "type": "string" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "config": { "type": "object" }, "sent": { "type": "boolean" }, "static": { "type": "boolean" }, "active": { "type": "boolean" }, "deepLinkCode": { "type": "string" }, "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentA11yMediaFileId": { "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": { "documentType": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/documentType" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "documentMediaFile": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/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": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/documentA11yMediaFile" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "0ea973a1104089c9d0f93bdb06c47cab" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteDocument": { "required": [ "id", "documentTypeId", "fileType", "quoteId", "config", "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentNumber": { "type": "string" }, "documentTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileType": { "type": "string" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "config": { "type": "object" }, "sent": { "type": "boolean" }, "static": { "type": "boolean" }, "active": { "type": "boolean" }, "deepLinkCode": { "type": "string" }, "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "documentType": { "$ref": "#/components/schemas/DocumentType" }, "quote": { "$ref": "#/components/schemas/Quote" }, "documentMediaFile": { "$ref": "#/components/schemas/Media" }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "QuoteEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "quoteId", "employeeId", "firstName", "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "employee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/employee" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteEmployee": { "required": ["id", "quoteId", "employeeId", "firstName", "lastName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quote": { "$ref": "#/components/schemas/Quote" }, "employee": { "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, "QuoteLineItemJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "quoteId", "identifier", "children", "states", "label", "quantity", "price", "position" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "states": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "payload": { "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "priceDefinition": { "type": "object" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "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" }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "purchasePrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "discount": { "properties": { "type": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "type": "object" }, "good": { "type": "boolean" }, "removable": { "type": "boolean" }, "stackable": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "referencedId": { "type": "string" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_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": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_line_item" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" }, "product": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/product" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, "promotion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/promotion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, "cover": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/cover" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, "deliveryPositions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/deliveryPositions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery_position" }, "id": { "type": "string", "example": "ef53ddda8fd07e19297084ad1219e97d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "QuoteLineItem": { "description": "Added since version: 6.5.3.0", "required": [ "id", "quoteId", "identifier", "children", "states", "label", "quantity", "price", "position" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "readOnly": true }, "states": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "payload": { "type": "object" }, "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "priceDefinition": { "type": "object" }, "price": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "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" }, "productPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "purchasePrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "discount": { "properties": { "type": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "type": "object" }, "good": { "type": "boolean" }, "removable": { "type": "boolean" }, "stackable": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "referencedId": { "type": "string" }, "coverId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quote": { "$ref": "#/components/schemas/Quote" }, "parent": { "$ref": "#/components/schemas/QuoteLineItem" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLineItem" } }, "product": { "$ref": "#/components/schemas/Product" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "cover": { "$ref": "#/components/schemas/Media" }, "deliveryPositions": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDeliveryPosition" } } }, "type": "object" }, "QuoteTransactionJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "quoteId", "paymentMethodId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "quote": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/quote" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/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" } ] }, "QuoteTransaction": { "description": "Added since version: 6.5.3.0", "required": ["id", "quoteId", "paymentMethodId", "amount"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "amount": { "required": ["unitPrice", "totalPrice", "quantity"], "properties": { "unitPrice": { "type": "number", "format": "float" }, "totalPrice": { "type": "number", "format": "float" }, "quantity": { "type": "integer", "format": "int64" }, "calculatedTaxes": { "type": "object" }, "taxRules": { "type": "object" }, "referencePrice": { "type": "object" }, "listPrice": { "properties": { "price": { "type": "number", "format": "float" }, "discount": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" } }, "type": "object" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" } }, "type": "object" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "quote": { "$ref": "#/components/schemas/Quote" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "RuleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "priority"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "invalid": { "type": "boolean", "readOnly": true }, "areas": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "customFields": { "type": "object" }, "moduleTypes": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptionPlans": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" }, "subscriptionIntervals": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_interval" }, "id": { "type": "string", "example": "28e0fbf8d26aa147681d2241c60ef075" } } } } }, "type": "object" }, "warehouseGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "example": "1768e3071b62161d415e0c24332055ed" } } } } }, "type": "object" }, "swagCmsExtensionsBlockRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagCmsExtensionsBlockRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_block_rule" }, "id": { "type": "string", "example": "ce0b9f43f8947576ee10c93d4d69a4c4" } } } } }, "type": "object" }, "customizedProductsTemplateOptionPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/customizedProductsTemplateOptionPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_price" }, "id": { "type": "string", "example": "00ece6d939b90beadc47a301e8b87a9e" } } } } }, "type": "object" }, "customizedProductsTemplateOptionValuePrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/customizedProductsTemplateOptionValuePrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value_price" }, "id": { "type": "string", "example": "67d7fb8f29b1a418ccf772dd5dee13a8" } } } } }, "type": "object" }, "swagDynamicAccessProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "acfed6b188b8ace53d2d2bb8dac196f0" } } } } }, "type": "object" }, "swagDynamicAccessCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "c9a96acd304adec0ef58961b00723adb" } } } } }, "type": "object" }, "swagDynamicAccessLandingPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessLandingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "34fd45ab970fb4ad3e96509b1936ddfb" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "conditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/conditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "b5b399ec1fcfe753f58dbafa197efdc1" } } } } }, "type": "object" }, "productPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_price" }, "id": { "type": "string", "example": "186169119da6d813def53830287d0b9a" } } } } }, "type": "object" }, "shippingMethodPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method_price" }, "id": { "type": "string", "example": "3702bcc7b41585828b44acbbdcd83b23" } } } } }, "type": "object" }, "shippingMethodPriceCalculations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method_price" }, "id": { "type": "string", "example": "b8ea8aac272229a90f9a6cb1fcada8d1" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "paymentMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "example": "b631b1ab565525e892f9cdc1242cca14" } } } } }, "type": "object" }, "personaPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "e6c8f116c04f26f18410d2d0dbd677db" } } } } }, "type": "object" }, "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" }, "taxProviders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_provider" }, "id": { "type": "string", "example": "01a1a9d428b6402dc8255d99c787a00e" } } } } }, "type": "object" }, "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "orderPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/orderPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "82dea0f7981e729cd7f6303cc8a1c499" } } } } }, "type": "object" }, "cartPromotions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion" }, "id": { "type": "string", "example": "2ce52c5be33293c67fb55f29fa4046a7" } } } } }, "type": "object" }, "promotionDiscounts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_discount" }, "id": { "type": "string", "example": "3ddb3f7d5ec4f032dc51f294409b68f9" } } } } }, "type": "object" }, "promotionSetGroups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "promotion_setgroup" }, "id": { "type": "string", "example": "b71b82231d40fdedf42133c0e71384f8" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Rule": { "description": "Added since version: 6.0.0.0", "required": ["id", "name", "priority"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "invalid": { "type": "boolean", "readOnly": true }, "areas": { "type": "array", "items": { "type": "object", "additionalProperties": false }, "readOnly": true }, "customFields": { "type": "object" }, "moduleTypes": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptionPlans": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" }, "subscriptionIntervals": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_interval" }, "id": { "type": "string", "example": "28e0fbf8d26aa147681d2241c60ef075" } } } } }, "type": "object" }, "warehouseGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "example": "1768e3071b62161d415e0c24332055ed" } } } } }, "type": "object" }, "swagCmsExtensionsBlockRules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagCmsExtensionsBlockRules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_block_rule" }, "id": { "type": "string", "example": "ce0b9f43f8947576ee10c93d4d69a4c4" } } } } }, "type": "object" }, "customizedProductsTemplateOptionPrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/customizedProductsTemplateOptionPrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_price" }, "id": { "type": "string", "example": "00ece6d939b90beadc47a301e8b87a9e" } } } } }, "type": "object" }, "customizedProductsTemplateOptionValuePrices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/customizedProductsTemplateOptionValuePrices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value_price" }, "id": { "type": "string", "example": "67d7fb8f29b1a418ccf772dd5dee13a8" } } } } }, "type": "object" }, "swagDynamicAccessProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "acfed6b188b8ace53d2d2bb8dac196f0" } } } } }, "type": "object" }, "swagDynamicAccessCategories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessCategories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "c9a96acd304adec0ef58961b00723adb" } } } } }, "type": "object" }, "swagDynamicAccessLandingPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/swagDynamicAccessLandingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "34fd45ab970fb4ad3e96509b1936ddfb" } } } } }, "type": "object" } }, "type": "object" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } }, "productPrices": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPrice" } }, "shippingMethodPrices": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "shippingMethodPriceCalculations": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } }, "personaPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "flowSequences": { "type": "array", "items": { "$ref": "#/components/schemas/FlowSequence" } }, "taxProviders": { "type": "array", "items": { "$ref": "#/components/schemas/TaxProvider" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "orderPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "cartPromotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "promotionDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionDiscount" } }, "promotionSetGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionSetgroup" } } }, "type": "object" }, "RuleConditionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "appScriptCondition": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app_script_condition" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d84ccced9bafd192ec0c6b5a8a49bc07" } } } }, "type": "object" }, "parent": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/parent" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, "children": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/children" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule_condition" }, "id": { "type": "string", "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "RuleCondition": { "description": "Added since version: 6.0.0.0", "required": ["id", "type", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "object" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "rule": { "$ref": "#/components/schemas/Rule" }, "appScriptCondition": { "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { "$ref": "#/components/schemas/RuleCondition" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, "RuleTag": { "description": "Added since version: 6.5.0.0", "required": ["ruleId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "rule": { "$ref": "#/components/schemas/Rule" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "SaasAppStorefrontConfigJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "appVersion", "appId", "technicalName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appVersion": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "isTheme": { "type": "boolean" }, "storefrontEntryPath": { "type": "string" }, "previewMedia": { "type": "string" }, "themeConfig": { "type": "object" }, "assetPaths": { "type": "array", "items": { "type": "string" } }, "viewInheritance": { "type": "array", "items": { "type": "string" } }, "styleFiles": { "type": "object" }, "scriptFiles": { "type": "object" }, "themeJson": { "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": "/saas-app-storefront-config/941d29c9ba5ba908e203784d6103906a/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" } ] }, "SaasAppStorefrontConfig": { "required": ["id", "appVersion", "appId", "technicalName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appVersion": { "type": "string" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "isTheme": { "type": "boolean" }, "storefrontEntryPath": { "type": "string" }, "previewMedia": { "type": "string" }, "themeConfig": { "type": "object" }, "assetPaths": { "type": "array", "items": { "type": "string" } }, "viewInheritance": { "type": "array", "items": { "type": "string" } }, "styleFiles": { "type": "object" }, "scriptFiles": { "type": "object" }, "themeJson": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "SaasStorefrontDemoTokenJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "token", "expiresAt", "userId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "token": { "type": "string", "readOnly": true }, "expiresAt": { "type": "string", "format": "date-time", "readOnly": true }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/saas-storefront-demo-token/6d788712a654b3860ec9cb23d47fe5d0/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" } ] }, "SaasStorefrontDemoToken": { "required": ["id", "token", "expiresAt", "userId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "token": { "type": "string", "readOnly": true }, "expiresAt": { "type": "string", "format": "date-time", "readOnly": true }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "SalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "typeId", "languageId", "customerGroupId", "currencyId", "paymentMethodId", "shippingMethodId", "countryId", "navigationCategoryId", "accessKey", "name", "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "typeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { "type": "integer", "format": "int64" }, "footerCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "footerCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "taxCalculationType": { "type": "string" }, "accessKey": { "type": "string" }, "configuration": { "type": "object" }, "active": { "type": "boolean" }, "hreflangActive": { "type": "boolean" }, "maintenance": { "type": "boolean" }, "maintenanceIpWhitelist": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "paymentMethodIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "homeCmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeCmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeSlotConfig": { "type": "object" }, "homeEnabled": { "type": "boolean" }, "homeName": { "type": "string" }, "homeMetaTitle": { "type": "string" }, "homeMetaDescription": { "type": "string" }, "homeKeywords": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" }, "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "paypalPosSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paypalPosSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "67ba77ec00554136bd30a09f2b79a091" } } } }, "type": "object" }, "socialShoppingSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/socialShoppingSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "be7393dc9d5ee6da46b8ccdf1b316101" } } } }, "type": "object" }, "socialShoppingProductErrors": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/socialShoppingProductErrors" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_product_error" }, "id": { "type": "string", "example": "74181afcb28901351a5f2676d1687de8" } } } } }, "type": "object" }, "swagSocialShoppingCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/swagSocialShoppingCustomer" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_customer" }, "id": { "type": "string", "example": "70825a5dfabd078bce265301ba7d9cca" } } } } }, "type": "object" }, "swagSocialShoppingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/swagSocialShoppingOrder" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_order" }, "id": { "type": "string", "example": "829fa9441f5dea1e7ada99a9ae4a867f" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" }, "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "typeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { "type": "integer", "format": "int64" }, "footerCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "footerCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "taxCalculationType": { "type": "string" }, "accessKey": { "type": "string" }, "configuration": { "type": "object" }, "active": { "type": "boolean" }, "hreflangActive": { "type": "boolean" }, "maintenance": { "type": "boolean" }, "maintenanceIpWhitelist": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "customFields": { "type": "object" }, "paymentMethodIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "readOnly": true }, "homeCmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeCmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "homeSlotConfig": { "type": "object" }, "homeEnabled": { "type": "boolean" }, "homeName": { "type": "string" }, "homeMetaTitle": { "type": "string" }, "homeMetaDescription": { "type": "string" }, "homeKeywords": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "themes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" }, "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "paypalPosSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paypalPosSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "67ba77ec00554136bd30a09f2b79a091" } } } }, "type": "object" }, "socialShoppingSalesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/socialShoppingSalesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "be7393dc9d5ee6da46b8ccdf1b316101" } } } }, "type": "object" }, "socialShoppingProductErrors": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/socialShoppingProductErrors" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_product_error" }, "id": { "type": "string", "example": "74181afcb28901351a5f2676d1687de8" } } } } }, "type": "object" }, "swagSocialShoppingCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/swagSocialShoppingCustomer" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_customer" }, "id": { "type": "string", "example": "70825a5dfabd078bce265301ba7d9cca" } } } } }, "type": "object" }, "swagSocialShoppingOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/swagSocialShoppingOrder" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_order" }, "id": { "type": "string", "example": "829fa9441f5dea1e7ada99a9ae4a867f" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" }, "advancedProductCatalogs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", "example": "fbec40add5492465d78b550a9a4ae26e" } } } } }, "type": "object" } }, "type": "object" }, "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": { "type": "string" }, "active": { "type": "boolean" }, "trackOrders": { "type": "boolean" }, "anonymizeIp": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "trackingId": { "type": "string" }, "active": { "type": "boolean" }, "trackOrders": { "type": "boolean" }, "anonymizeIp": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SalesChannelCountry": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "countryId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "country": { "$ref": "#/components/schemas/Country" } }, "type": "object" }, "SalesChannelCurrency": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "currencyId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "SalesChannelDomainJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "url", "salesChannelId", "languageId", "currencyId", "snippetSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "url": { "type": "string" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "dsrAppointmentGuideSalesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/dsrAppointmentGuideSalesChannelDomain" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "d68bf355eb36d46d6fa55a4db7696181" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "snippetSet": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "543af5fd1912efc00742534f621046d3" } } } }, "type": "object" }, "salesChannelDefaultHreflang": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8d7b798a77667d73c422fb222603234c" } } } }, "type": "object" }, "productExports": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_export" }, "id": { "type": "string", "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelDomain": { "description": "Added since version: 6.0.0.0", "required": [ "id", "url", "salesChannelId", "languageId", "currencyId", "snippetSetId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "url": { "type": "string" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "dsrAppointmentGuideSalesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/dsrAppointmentGuideSalesChannelDomain" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "d68bf355eb36d46d6fa55a4db7696181" } } } } }, "type": "object" }, "socialShoppingSalesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/socialShoppingSalesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_social_shopping_sales_channel" }, "id": { "type": "string", "example": "e581067f817be66449a3f4350dc327af" } } } } }, "type": "object" } }, "type": "object" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" }, "currency": { "$ref": "#/components/schemas/Currency" }, "snippetSet": { "$ref": "#/components/schemas/SnippetSet" }, "salesChannelDefaultHreflang": { "$ref": "#/components/schemas/SalesChannel" }, "productExports": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExport" } } }, "type": "object" }, "SalesChannelLanguage": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "languageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "SalesChannelPaymentMethod": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "paymentMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, "SalesChannelShippingMethod": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "shippingMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" } }, "type": "object" }, "SalesChannelTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { "type": "string" }, "iconName": { "type": "string" }, "screenshotUrls": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "manufacturer": { "type": "string" }, "description": { "type": "string" }, "descriptionLong": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SalesChannelType": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { "type": "string" }, "iconName": { "type": "string" }, "screenshotUrls": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "manufacturer": { "type": "string" }, "description": { "type": "string" }, "descriptionLong": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, "SalutationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salutationKey", "displayName", "letterName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { "type": "string" }, "displayName": { "type": "string" }, "letterName": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_customer" }, "id": { "type": "string", "example": "ee8811605866488e8f21308857e1e5a8" } } } } }, "type": "object" }, "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "customerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer_address" }, "id": { "type": "string", "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } } }, "type": "object" }, "orderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_customer" }, "id": { "type": "string", "example": "1e7dbe7e3bcb48d233fd80588f54c980" } } } } }, "type": "object" }, "orderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_address" }, "id": { "type": "string", "example": "c3182f0dc0cc20b4982616d3e0221747" } } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Salutation": { "description": "Added since version: 6.0.0.0", "required": ["id", "salutationKey", "displayName", "letterName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { "type": "string" }, "displayName": { "type": "string" }, "letterName": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptionCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_customer" }, "id": { "type": "string", "example": "ee8811605866488e8f21308857e1e5a8" } } } } }, "type": "object" }, "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" }, "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/b2bPendingOrderAddresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" } }, "type": "object" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "customerAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" } }, "orderCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCustomer" } }, "orderAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } } }, "type": "object" }, "ScheduledTaskJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "name", "scheduledTaskClass", "runInterval", "defaultRunInterval", "status" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "scheduledTaskClass": { "type": "string" }, "runInterval": { "type": "integer", "format": "int64" }, "defaultRunInterval": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "lastExecutionTime": { "type": "string", "format": "date-time" }, "nextExecutionTime": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "ScheduledTask": { "description": "Added since version: 6.0.0.0", "required": [ "id", "name", "scheduledTaskClass", "runInterval", "defaultRunInterval", "status" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "scheduledTaskClass": { "type": "string" }, "runInterval": { "type": "integer", "format": "int64" }, "defaultRunInterval": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "lastExecutionTime": { "type": "string", "format": "date-time" }, "nextExecutionTime": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "ScriptJsonApi": { "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "script", "hook", "name", "active"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "script": { "type": "string" }, "hook": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/script/f907e651164789346ae0a1e257c462d8/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Script": { "description": "Added since version: 6.4.7.0", "required": ["id", "script", "hook", "name", "active"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "script": { "type": "string" }, "hook": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "SeoUrlJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "languageId", "foreignKey", "routeName", "pathInfo", "seoPathInfo" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { "type": "string" }, "pathInfo": { "type": "string" }, "seoPathInfo": { "type": "string" }, "isCanonical": { "type": "boolean" }, "isModified": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "error": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SeoUrl": { "description": "Added since version: 6.0.0.0", "required": [ "id", "languageId", "foreignKey", "routeName", "pathInfo", "seoPathInfo" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { "type": "string" }, "pathInfo": { "type": "string" }, "seoPathInfo": { "type": "string" }, "isCanonical": { "type": "boolean" }, "isModified": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "error": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "url": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "SeoUrlTemplateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "entityName", "routeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "routeName": { "type": "string" }, "template": { "type": "string" }, "isValid": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", "required": ["id", "entityName", "routeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "routeName": { "type": "string" }, "template": { "type": "string" }, "isValid": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "ShippingMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "deliveryTimeId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "active": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { "type": "string" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": { "type": "string" }, "trackingUrl": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quoteDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery" }, "id": { "type": "string", "example": "2aabe64723fb0f621446cd7b5c04f15e" } } } } }, "type": "object" }, "organizations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/organizations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "d9811f03b461a380c0d6b4a497dbac37" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "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}$" }, "name": { "type": "string" }, "technicalName": { "type": "string" }, "active": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { "type": "string" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": { "type": "string" }, "trackingUrl": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "quoteDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_delivery" }, "id": { "type": "string", "example": "2aabe64723fb0f621446cd7b5c04f15e" } } } } }, "type": "object" }, "organizations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/organizations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_organization" }, "id": { "type": "string", "example": "d9811f03b461a380c0d6b4a497dbac37" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "deliveryTime": { "$ref": "#/components/schemas/DeliveryTime", "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": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { "type": "integer", "format": "int64" }, "calculationRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { "type": "number", "format": "float" }, "quantityEnd": { "type": "number", "format": "float" }, "currencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "calculationRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/calculationRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "01b78fd34df634d784131ceefffbac99" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "ShippingMethodPrice": { "description": "Added since version: 6.0.0.0", "required": ["id", "shippingMethodId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { "type": "integer", "format": "int64" }, "calculationRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { "type": "number", "format": "float" }, "quantityEnd": { "type": "number", "format": "float" }, "currencyPrice": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "rule": { "$ref": "#/components/schemas/Rule" }, "calculationRule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "ShippingMethodTag": { "description": "Added since version: 6.0.0.0", "required": ["shippingMethodId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "SnippetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "setId", "translationKey", "value", "author"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "setId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { "type": "string" }, "value": { "type": "string" }, "author": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "set": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Snippet": { "description": "Added since version: 6.0.0.0", "required": ["id", "setId", "translationKey", "value", "author"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "setId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { "type": "string" }, "value": { "type": "string" }, "author": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "set": { "$ref": "#/components/schemas/SnippetSet" } }, "type": "object" }, "SnippetSetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "baseFile", "iso"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "baseFile": { "type": "string" }, "iso": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "snippets": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "snippet" }, "id": { "type": "string", "example": "67be68a348da3b850fb7daa10b034528" } } } } }, "type": "object" }, "salesChannelDomains": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel_domain" }, "id": { "type": "string", "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SnippetSet": { "description": "Added since version: 6.0.0.0", "required": ["id", "name", "baseFile", "iso"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "baseFile": { "type": "string" }, "iso": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "snippets": { "type": "array", "items": { "$ref": "#/components/schemas/Snippet" } }, "salesChannelDomains": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" } } }, "type": "object" }, "SpatialRenderConfigSizeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "width", "height"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "width": { "type": "integer", "format": "int64" }, "height": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "SpatialRenderConfigSize": { "required": ["id", "name", "width", "height"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "width": { "type": "integer", "format": "int64" }, "height": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "SpatialSceneJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "backgroundEnabled": { "type": "boolean" }, "backgroundColor": { "type": "string" }, "floorEnabled": { "type": "boolean" }, "floorColor": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "objects": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/objects" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_object" }, "id": { "type": "string", "example": "5891da2d64975cae48d175d1e001f5da" } } } } }, "type": "object" }, "cameras": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/cameras" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_camera" }, "id": { "type": "string", "example": "036651ad64ffb926ca7a2759af327a8a" } } } } }, "type": "object" }, "lights": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/lights" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_light" }, "id": { "type": "string", "example": "278e59671a1a559c4bc61d226cd217cd" } } } } }, "type": "object" }, "groups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/groups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "example": "1471e4e05a4db95d353cc867fe317314" } } } } }, "type": "object" }, "primitives": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/primitives" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_primitive" }, "id": { "type": "string", "example": "9e1458cd0f9b5cb89abeeed7490f1446" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialScene": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "backgroundEnabled": { "type": "boolean" }, "backgroundColor": { "type": "string" }, "floorEnabled": { "type": "boolean" }, "floorColor": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } }, "cameras": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } }, "lights": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "primitives": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } } }, "type": "object" }, "SpatialSceneCameraJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "target": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "relationships": { "properties": { "scene": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/scene" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, "parentGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/parentGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70eeadaa8569846e35f40fff3603a7a7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialSceneCamera": { "required": ["id", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "target": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, "parentGroup": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, "SpatialSceneGroupJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "relationships": { "properties": { "objects": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/objects" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_object" }, "id": { "type": "string", "example": "5891da2d64975cae48d175d1e001f5da" } } } } }, "type": "object" }, "cameras": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/cameras" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_camera" }, "id": { "type": "string", "example": "036651ad64ffb926ca7a2759af327a8a" } } } } }, "type": "object" }, "lights": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/lights" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_light" }, "id": { "type": "string", "example": "278e59671a1a559c4bc61d226cd217cd" } } } } }, "type": "object" }, "groups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/groups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "example": "1471e4e05a4db95d353cc867fe317314" } } } } }, "type": "object" }, "primitives": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/primitives" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_primitive" }, "id": { "type": "string", "example": "9e1458cd0f9b5cb89abeeed7490f1446" } } } } }, "type": "object" }, "scene": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/scene" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, "parentGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/parentGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70eeadaa8569846e35f40fff3603a7a7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialSceneGroup": { "required": ["id", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } }, "cameras": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneCamera" } }, "lights": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneLight" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "primitives": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, "parentGroup": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, "SpatialSceneLightJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "intensity": { "type": "number", "format": "float" }, "color": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "relationships": { "properties": { "scene": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/scene" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, "parentGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/parentGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70eeadaa8569846e35f40fff3603a7a7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialSceneLight": { "required": ["id", "type", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "intensity": { "type": "number", "format": "float" }, "color": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, "parentGroup": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, "SpatialSceneMaterialJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "color", "metalness", "roughness"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "color": { "type": "string" }, "metalness": { "type": "number", "format": "float" }, "roughness": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "primitives": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-material/902c4f06a9bae5968b45aefbb0a2b09f/primitives" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_primitive" }, "id": { "type": "string", "example": "9e1458cd0f9b5cb89abeeed7490f1446" } } } } }, "type": "object" }, "objects": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-material/902c4f06a9bae5968b45aefbb0a2b09f/objects" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_object" }, "id": { "type": "string", "example": "5891da2d64975cae48d175d1e001f5da" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialSceneMaterial": { "required": ["id", "color", "metalness", "roughness"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "color": { "type": "string" }, "metalness": { "type": "number", "format": "float" }, "roughness": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "primitives": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialScenePrimitive" } }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneObject" } } }, "type": "object" }, "SpatialSceneObjectJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "mediaId", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "relationships": { "properties": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "materials": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/materials" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_material" }, "id": { "type": "string", "example": "2d2ac038a83870def5a37f56545b8f2b" } } } } }, "type": "object" }, "scene": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/scene" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, "parentGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/parentGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70eeadaa8569846e35f40fff3603a7a7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialSceneObject": { "required": ["id", "mediaId", "name", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "media": { "$ref": "#/components/schemas/Media" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/SpatialSceneMaterial" } }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, "parentGroup": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, "SpatialSceneObjectMaterial": { "required": ["objectId", "materialId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "objectId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "materialId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "object": { "$ref": "#/components/schemas/SpatialSceneObject" }, "material": { "$ref": "#/components/schemas/SpatialSceneMaterial" } }, "type": "object" }, "SpatialScenePrimitiveJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "geometry", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "materialId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "geometry": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "relationships": { "properties": { "material": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/material" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_material" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "eec34d804c9ce6c89cff596be555e6a4" } } } }, "type": "object" }, "scene": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/scene" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, "parentGroup": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/parentGroup" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "70eeadaa8569846e35f40fff3603a7a7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SpatialScenePrimitive": { "required": ["id", "name", "geometry", "sceneId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "materialId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "geometry": { "type": "string" }, "position": { "type": "object" }, "rotation": { "type": "object" }, "scale": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "visible": { "type": "boolean" }, "locked": { "type": "boolean" }, "afterId": { "type": "string" }, "childCount": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "integer", "format": "int64" }, "material": { "$ref": "#/components/schemas/SpatialSceneMaterial" }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, "parentGroup": { "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, "SsoProviderJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "type", "active", "config"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "active": { "type": "boolean" }, "config": { "type": "object" }, "mediaId": { "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": { "ssoProviderCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sso-provider/179b43520e8619ff3a0ff51723f7e827/ssoProviderCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider_customer" }, "id": { "type": "string", "example": "6f2bd941c85a0835cd1889fd0a2c835a" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sso-provider/179b43520e8619ff3a0ff51723f7e827/media" } } }, "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" } ] }, "SsoProvider": { "required": ["id", "name", "type", "active", "config"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "type": { "type": "string" }, "active": { "type": "boolean" }, "config": { "type": "object" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "ssoProviderCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/SsoProviderCustomer" } }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "SsoProviderCustomerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "ssoProviderId", "customerId", "subject"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ssoProviderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subject": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "ssoProvider": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sso-provider-customer/bfea076e6e55c14790133b1314edcdb2/ssoProvider" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sso_provider" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "643b6966b5e1ecd3029a10a40f7b85ff" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/sso-provider-customer/bfea076e6e55c14790133b1314edcdb2/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" } ] }, "SsoProviderCustomer": { "required": ["id", "ssoProviderId", "customerId", "subject"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ssoProviderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subject": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "ssoProvider": { "$ref": "#/components/schemas/SsoProvider" }, "customer": { "$ref": "#/components/schemas/Customer" } }, "type": "object" }, "StateMachineJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "initialStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "states": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/states" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } } }, "type": "object" }, "transitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/transitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "34fe3c1def90f54754c23fb8df6dbeb0" } } } } }, "type": "object" }, "historyEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/historyEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "83f6d6b77ef224687b7b34cfe4296bea" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachine": { "description": "Added since version: 6.0.0.0", "required": ["id", "technicalName", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "initialStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineState" } }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "historyEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } }, "type": "object" }, "StateMachineHistoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "referencedId", "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/fromStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b108a2a0d303fafc83ef06f6790722e8" } } } }, "type": "object" }, "toStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/toStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" } } } }, "type": "object" }, "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-history/2981354377022484094791c3f19ffec8/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, "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}$" }, "referencedId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { "type": "string" }, "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "toStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "user": { "$ref": "#/components/schemas/User" }, "integration": { "$ref": "#/components/schemas/Integration" } }, "type": "object" }, "StateMachineStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "stateMachineId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "orderReturns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderReturns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "e062ff5da223b1e61bb4f72a7808b23b" } } } } }, "type": "object" }, "orderReturnLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderReturnLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "56ae6981fe0ca866f2bedad1b47ddcc3" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineTransitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineTransitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "80afc3e35f99674237f602b393d3b2ba" } } } } }, "type": "object" }, "toStateMachineTransitions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineTransitions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_transition" }, "id": { "type": "string", "example": "eb2ca150be27264985d0fcf20d53408d" } } } } }, "type": "object" }, "orderTransactions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } } }, "type": "object" }, "orderDeliveries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderDeliveries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_delivery" }, "id": { "type": "string", "example": "0ba472de56dd7ba2e7bb878434321e26" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "orderTransactionCaptures": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptures" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture" }, "id": { "type": "string", "example": "a32c8bdb9e1154cf4e138a0c8faa7159" } } } } }, "type": "object" }, "orderTransactionCaptureRefunds": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptureRefunds" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction_capture_refund" }, "id": { "type": "string", "example": "24fe1cc759f5450a1d5984a61ad20bda" } } } } }, "type": "object" }, "toStateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "01326b3b7d7c9c9182eb3940bb456c50" } } } } }, "type": "object" }, "fromStateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "6e4fe8b42b9cffa16c3e7b7e4a2a836d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": ["id", "technicalName", "stateMachineId", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "orderReturns": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderReturns" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "e062ff5da223b1e61bb4f72a7808b23b" } } } } }, "type": "object" }, "orderReturnLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderReturnLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return_line_item" }, "id": { "type": "string", "example": "56ae6981fe0ca866f2bedad1b47ddcc3" } } } } }, "type": "object" }, "orderLineItems": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderLineItems" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_line_item" }, "id": { "type": "string", "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "98dec49a83119c512f84645e81ea52d8" } } } } }, "type": "object" }, "b2bPendingOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/b2bPendingOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_pending_order" }, "id": { "type": "string", "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" } }, "type": "object" }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "toStateMachineTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineTransition" } }, "orderTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "orderDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "orderTransactionCaptures": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } }, "orderTransactionCaptureRefunds": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } }, "toStateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "fromStateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } } }, "type": "object" }, "StateMachineTransitionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "actionName", "stateMachineId", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { "type": "string" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "stateMachine": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/stateMachine" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, "fromStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/fromStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b108a2a0d303fafc83ef06f6790722e8" } } } }, "type": "object" }, "toStateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/toStateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "StateMachineTransition": { "description": "Added since version: 6.0.0.0", "required": [ "id", "actionName", "stateMachineId", "fromStateId", "toStateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { "type": "string" }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "stateMachine": { "$ref": "#/components/schemas/StateMachine" }, "fromStateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "toStateMachineState": { "$ref": "#/components/schemas/StateMachineState" } }, "type": "object" }, "SubscriptionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "convertedOrder", "subscriptionNumber", "nextSchedule", "followingNextSchedule", "salesChannelId", "subscriptionPlanName", "subscriptionIntervalName", "dateInterval", "cronInterval", "billingAddressId", "shippingAddressId", "shippingMethodId", "paymentMethodId", "currencyId", "languageId", "stateId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "convertedOrder": { "type": "object" }, "subscriptionNumber": { "type": "string" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "nextSchedule": { "type": "string", "format": "date-time" }, "followingNextSchedule": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "format": "date-time" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanName": { "type": "string" }, "subscriptionIntervalId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionIntervalName": { "type": "string" }, "dateInterval": { "type": "string" }, "cronInterval": { "type": "string" }, "initialExecutionCount": { "type": "integer", "format": "int64" }, "remainingExecutionCount": { "type": "integer", "format": "int64" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "initialOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "initialOrderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "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": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "subscriptionPlan": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionPlan" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cc77ba4ffd2f2fe79753e342bf273e18" } } } }, "type": "object" }, "subscriptionInterval": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionInterval" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_interval" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "411797824a15b44b931bc4b9e614fb79" } } } }, "type": "object" }, "subscriptionCustomer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionCustomer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6b5e1e89a3d596fceff0f09fdbb41770" } } } }, "type": "object" }, "billingAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/billingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" }, "shippingAddress": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/shippingAddress" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8ced05ad5d4ac52bbf7f4b1413f35521" } } } }, "type": "object" }, "addresses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/addresses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_address" }, "id": { "type": "string", "example": "963e3a2fe559e393bad631f3dc686f69" } } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "shippingMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/shippingMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, "stateMachineState": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/stateMachineState" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "tags": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/tags" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tag" }, "id": { "type": "string", "example": "d57ac45256849d9b13e2422d91580fb9" } } } } }, "type": "object" }, "currency": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/currency" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/language" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, "initialOrder": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/initialOrder" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5dd26f6705e75ee9dc0876dc5cdc739a" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Subscription": { "required": [ "id", "convertedOrder", "subscriptionNumber", "nextSchedule", "followingNextSchedule", "salesChannelId", "subscriptionPlanName", "subscriptionIntervalName", "dateInterval", "cronInterval", "billingAddressId", "shippingAddressId", "shippingMethodId", "paymentMethodId", "currencyId", "languageId", "stateId", "itemRounding", "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "convertedOrder": { "type": "object" }, "subscriptionNumber": { "type": "string" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "nextSchedule": { "type": "string", "format": "date-time" }, "followingNextSchedule": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "format": "date-time" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanName": { "type": "string" }, "subscriptionIntervalId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionIntervalName": { "type": "string" }, "dateInterval": { "type": "string" }, "cronInterval": { "type": "string" }, "initialExecutionCount": { "type": "integer", "format": "int64" }, "remainingExecutionCount": { "type": "integer", "format": "int64" }, "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "initialOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "initialOrderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "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 }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "subscriptionPlan": { "$ref": "#/components/schemas/SubscriptionPlan" }, "subscriptionInterval": { "$ref": "#/components/schemas/SubscriptionInterval" }, "subscriptionCustomer": { "$ref": "#/components/schemas/SubscriptionCustomer" }, "billingAddress": { "$ref": "#/components/schemas/SubscriptionAddress" }, "shippingAddress": { "$ref": "#/components/schemas/SubscriptionAddress" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAddress" } }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "currency": { "$ref": "#/components/schemas/Currency" }, "language": { "$ref": "#/components/schemas/Language" }, "initialOrder": { "$ref": "#/components/schemas/Order" } }, "type": "object" }, "SubscriptionAddressJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "countryId", "subscriptionId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "billingSubscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-address/63f6fea69c128c002aa378821b168c76/billingSubscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "5c80db3824a615a8c5494779f006418d" } } } }, "type": "object" }, "shippingSubscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-address/63f6fea69c128c002aa378821b168c76/shippingSubscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "45791ef15bb346d90a50fc87adbabbbc" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-address/63f6fea69c128c002aa378821b168c76/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": "/subscription-address/63f6fea69c128c002aa378821b168c76/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": "/subscription-address/63f6fea69c128c002aa378821b168c76/salutation" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, "subscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-address/63f6fea69c128c002aa378821b168c76/subscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SubscriptionAddress": { "required": [ "id", "countryId", "subscriptionId", "firstName", "lastName", "street", "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "street": { "type": "string" }, "zipcode": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "department": { "type": "string" }, "title": { "type": "string" }, "vatId": { "type": "string" }, "phoneNumber": { "type": "string" }, "additionalAddressLine1": { "type": "string" }, "additionalAddressLine2": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "billingSubscription": { "$ref": "#/components/schemas/Subscription" }, "shippingSubscription": { "$ref": "#/components/schemas/Subscription" }, "country": { "$ref": "#/components/schemas/Country" }, "countryState": { "$ref": "#/components/schemas/CountryState" }, "salutation": { "$ref": "#/components/schemas/Salutation" }, "subscription": { "$ref": "#/components/schemas/Subscription" } }, "type": "object" }, "SubscriptionCustomerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "subscriptionId", "salutationId", "email", "firstName", "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "customerNumber": { "type": "string" }, "vatIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "subscription": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-customer/2bbf8cc18dfb0a95c32f2a79905723d9/subscription" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, "customer": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-customer/2bbf8cc18dfb0a95c32f2a79905723d9/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": "/subscription-customer/2bbf8cc18dfb0a95c32f2a79905723d9/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" } ] }, "SubscriptionCustomer": { "required": [ "id", "subscriptionId", "salutationId", "email", "firstName", "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "customerNumber": { "type": "string" }, "vatIds": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "remoteAddress": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "subscription": { "$ref": "#/components/schemas/Subscription" }, "customer": { "$ref": "#/components/schemas/Customer" }, "salutation": { "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, "SubscriptionIntervalJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "delayed"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "dateInterval": { "type": "string" }, "cronInterval": { "type": "string" }, "delayed": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-interval/6908067ce08a164d022b6a07940ebc7b/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" }, "availabilityRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-interval/6908067ce08a164d022b6a07940ebc7b/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "subscriptionPlans": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-interval/6908067ce08a164d022b6a07940ebc7b/subscriptionPlans" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_plan" }, "id": { "type": "string", "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SubscriptionInterval": { "required": ["id", "name", "delayed"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "dateInterval": { "type": "string" }, "cronInterval": { "type": "string" }, "delayed": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "subscriptionPlans": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } }, "type": "object" }, "SubscriptionPlanJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "minimumExecutionCount": { "type": "integer", "format": "int64" }, "activeStorefrontLabel": { "type": "boolean" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountPercentage": { "type": "number", "format": "float" }, "label": { "type": "string" }, "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": "/subscription-plan/5e63f9057837020694081b9412211bfb/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "subscriptionIntervals": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptionIntervals" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription_interval" }, "id": { "type": "string", "example": "28e0fbf8d26aa147681d2241c60ef075" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/subscription-plan/5e63f9057837020694081b9412211bfb/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SubscriptionPlan": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "minimumExecutionCount": { "type": "integer", "format": "int64" }, "activeStorefrontLabel": { "type": "boolean" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "discountPercentage": { "type": "number", "format": "float" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "subscriptionIntervals": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionInterval" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } }, "type": "object" }, "SubscriptionPlanIntervalMapping": { "required": ["subscriptionIntervalId", "subscriptionPlanId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionIntervalId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlan": { "$ref": "#/components/schemas/SubscriptionPlan" }, "subscriptionInterval": { "$ref": "#/components/schemas/SubscriptionInterval" } }, "type": "object" }, "SubscriptionPlanProductMapping": { "required": ["productId", "subscriptionPlanId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlanId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionPlan": { "$ref": "#/components/schemas/SubscriptionPlan" }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "SubscriptionTagMapping": { "required": ["subscriptionId", "tagId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "subscription": { "$ref": "#/components/schemas/Subscription" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "SwagCmsExtensionsBlockRuleJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "cmsBlockId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "inverted": { "type": "boolean" }, "visibilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "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": { "visibilityRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-block-rule/f36890a9656215be0edf2204ba8dc876/visibilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6efc965839211c3f91ba4d7d2a3fc9f3" } } } }, "type": "object" }, "cmsBlock": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-block-rule/f36890a9656215be0edf2204ba8dc876/cmsBlock" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "87a71f31728ecc19c2e87fbe9face4b2" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsBlockRule": { "required": ["id", "cmsBlockId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "inverted": { "type": "boolean" }, "visibilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "visibilityRule": { "$ref": "#/components/schemas/Rule" }, "cmsBlock": { "$ref": "#/components/schemas/CmsBlock" } }, "type": "object" }, "SwagCmsExtensionsFormJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "mailTemplateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSlotId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSlotVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "isTemplate": { "type": "boolean" }, "technicalName": { "type": "string" }, "title": { "type": "string" }, "successMessage": { "type": "string" }, "receivers": { "type": "object" }, "mailTemplateId": { "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": { "groups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form/f06a6b72709adae43e1e94ef1caa8e5f/groups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form_group" }, "id": { "type": "string", "example": "1471e4e05a4db95d353cc867fe317314" } } } } }, "type": "object" }, "cmsSlot": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form/f06a6b72709adae43e1e94ef1caa8e5f/cmsSlot" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_slot" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e1306ba9f900039b95359c03fa95dd8b" } } } }, "type": "object" }, "mailTemplate": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form/f06a6b72709adae43e1e94ef1caa8e5f/mailTemplate" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "mail_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "246e2bdec01d63875c35f120d7b05092" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsForm": { "required": ["id", "technicalName", "mailTemplateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSlotId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsSlotVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "isTemplate": { "type": "boolean" }, "technicalName": { "type": "string" }, "title": { "type": "string" }, "successMessage": { "type": "string" }, "receivers": { "type": "object" }, "mailTemplateId": { "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" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } }, "cmsSlot": { "$ref": "#/components/schemas/CmsSlot" }, "mailTemplate": { "$ref": "#/components/schemas/MailTemplate" } }, "type": "object" }, "SwagCmsExtensionsFormGroupJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "position"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "formId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "title": { "type": "string" }, "technicalName": { "type": "string" }, "position": { "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": { "fields": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form-group/468e2351f66daae01feec5952fa04897/fields" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form_group_field" }, "id": { "type": "string", "example": "d05b6ed7d2345020440df396d6da7f73" } } } } }, "type": "object" }, "form": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form-group/468e2351f66daae01feec5952fa04897/form" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "3fcdb73d36d54f2cc22d0f68e6b6e182" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsFormGroup": { "required": ["id", "technicalName", "position"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "formId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "title": { "type": "string" }, "technicalName": { "type": "string" }, "position": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroupField" } }, "form": { "$ref": "#/components/schemas/SwagCmsExtensionsForm" } }, "type": "object" }, "SwagCmsExtensionsFormGroupFieldJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "position", "width", "type", "technicalName", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "width": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "technicalName": { "type": "string" }, "required": { "type": "boolean" }, "label": { "type": "string" }, "placeholder": { "type": "string" }, "errorMessage": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "group": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-form-group-field/8c53232660618aa34371b17b0fddac3d/group" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_cms_extensions_form_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsFormGroupField": { "required": [ "id", "position", "width", "type", "technicalName", "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { "type": "integer", "format": "int64" }, "width": { "type": "integer", "format": "int64" }, "type": { "type": "string" }, "technicalName": { "type": "string" }, "required": { "type": "boolean" }, "label": { "type": "string" }, "placeholder": { "type": "string" }, "errorMessage": { "type": "string" }, "config": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "group": { "$ref": "#/components/schemas/SwagCmsExtensionsFormGroup" } }, "type": "object" }, "SwagCmsExtensionsQuickviewJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "cmsBlockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "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": { "cmsBlock": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-quickview/93c1c8d93a2120d8141e5fed74a16dce/cmsBlock" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_block" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "87a71f31728ecc19c2e87fbe9face4b2" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsQuickview": { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "cmsBlockId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsBlockVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "cmsBlock": { "$ref": "#/components/schemas/CmsBlock" } }, "type": "object" }, "SwagCmsExtensionsScrollNavigationJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayName": { "type": "string" }, "cmsSectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "cmsSection": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-scroll-navigation/fe6e0a5fca8ed3c312de3ba20a10be99/cmsSection" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_section" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "212545e6991db0675b783d4574ab20dc" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsScrollNavigation": { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "cmsSectionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayName": { "type": "string" }, "cmsSectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "cmsSection": { "$ref": "#/components/schemas/CmsSection" } }, "type": "object" }, "SwagCmsExtensionsScrollNavigationPageSettingsJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "nativeScrolling"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "duration": { "type": "integer", "format": "int64" }, "easing": { "type": "string" }, "bouncy": { "type": "boolean" }, "easingDegree": { "type": "integer", "format": "int64" }, "nativeScrolling": { "type": "boolean" }, "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 }, "relationships": { "properties": { "cmsPage": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-cms-extensions-scroll-navigation-page-settings/ee67f9f8361095c164fecc7e32aace8d/cmsPage" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCmsExtensionsScrollNavigationPageSettings": { "required": ["id", "nativeScrolling"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "active": { "type": "boolean" }, "duration": { "type": "integer", "format": "int64" }, "easing": { "type": "string" }, "bouncy": { "type": "boolean" }, "easingDegree": { "type": "integer", "format": "int64" }, "nativeScrolling": { "type": "boolean" }, "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 }, "cmsPage": { "$ref": "#/components/schemas/CmsPage" } }, "type": "object" }, "SwagCustomizedProductsTemplateJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "internalName", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "internalName": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "stepByStep": { "type": "boolean" }, "confirmInput": { "type": "boolean" }, "optionsAutoCollapse": { "type": "boolean" }, "decisionTree": { "type": "object", "readOnly": true }, "mediaId": { "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": { "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template/4751e4cb483e992aa073494b9cfa9be6/media" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, "options": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template/4751e4cb483e992aa073494b9cfa9be6/options" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "example": "93da65a9fd0004d9477aeac024e08e15" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template/4751e4cb483e992aa073494b9cfa9be6/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "exclusions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template/4751e4cb483e992aa073494b9cfa9be6/exclusions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion" }, "id": { "type": "string", "example": "c6fc0a7508c1a1fe9e233e81d31133b8" } } } } }, "type": "object" }, "configurations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template/4751e4cb483e992aa073494b9cfa9be6/configurations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_configuration" }, "id": { "type": "string", "example": "86f23519571eb918e8812e1979d55409" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplate": { "required": ["id", "internalName", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "internalName": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "stepByStep": { "type": "boolean" }, "confirmInput": { "type": "boolean" }, "optionsAutoCollapse": { "type": "boolean" }, "decisionTree": { "type": "object", "readOnly": true }, "mediaId": { "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" }, "media": { "$ref": "#/components/schemas/Media" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "exclusions": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } }, "configurations": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } }, "type": "object" }, "SwagCustomizedProductsTemplateConfigurationJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "hash", "configuration", "templateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "configuration": { "type": "object" }, "templateId": { "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": { "template": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-configuration/ab78fa5f6df63876a7c6575bdf517fe2/template" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "66f6181bcb4cff4cd38fbc804a036db6" } } } }, "type": "object" }, "templateConfigurationShares": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-configuration/ab78fa5f6df63876a7c6575bdf517fe2/templateConfigurationShares" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_configuration_share" }, "id": { "type": "string", "example": "81a31c81fde24f296e176502d32baa6d" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateConfiguration": { "required": ["id", "hash", "configuration", "templateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "configuration": { "type": "object" }, "templateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "template": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" }, "templateConfigurationShares": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } }, "type": "object" }, "SwagCustomizedProductsTemplateConfigurationShareJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "templateConfigurationId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateConfigurationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "oneTime": { "type": "boolean" }, "templateConfigurationId": { "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": { "templateConfiguration": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-configuration-share/9ed7d8ec8fa2b6e96c0ab1803eb42789/templateConfiguration" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_configuration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "82a3b2de8107d3e15a17f2d4278c849c" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateConfigurationShare": { "required": ["id", "templateConfigurationId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateConfigurationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "oneTime": { "type": "boolean" }, "templateConfigurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "templateConfiguration": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } }, "type": "object" }, "SwagCustomizedProductsTemplateExclusionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "templateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "templateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "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": { "conditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion/d28221401a2fa711c59f4bb8cbd9d06e/conditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion_condition" }, "id": { "type": "string", "example": "b5b399ec1fcfe753f58dbafa197efdc1" } } } } }, "type": "object" }, "template": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion/d28221401a2fa711c59f4bb8cbd9d06e/template" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "66f6181bcb4cff4cd38fbc804a036db6" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateExclusion": { "required": ["id", "name", "templateId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "templateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } }, "template": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } }, "type": "object" }, "SwagCustomizedProductsTemplateExclusionConditionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "templateExclusionId", "templateOptionId", "templateExclusionOperatorId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionOperatorId": { "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": { "templateExclusion": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion-condition/7fb5a2315280913d00c5ff5a0415afcf/templateExclusion" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "13cbb51fc716b7cdd04a5e995b57cce4" } } } }, "type": "object" }, "templateOption": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion-condition/7fb5a2315280913d00c5ff5a0415afcf/templateOption" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6891a002a90a39e71e67c4fc148db8df" } } } }, "type": "object" }, "templateExclusionOperator": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion-condition/7fb5a2315280913d00c5ff5a0415afcf/templateExclusionOperator" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion_operator" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "8a3c6855d1712345c9fe9468425bfe2e" } } } }, "type": "object" }, "templateOptionValues": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion-condition/7fb5a2315280913d00c5ff5a0415afcf/templateOptionValues" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value" }, "id": { "type": "string", "example": "7d3eaa0fb0118db414750bb30b0582b6" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateExclusionCondition": { "required": [ "id", "templateExclusionId", "templateOptionId", "templateExclusionOperatorId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionOperatorId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "templateExclusion": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" }, "templateOption": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" }, "templateExclusionOperator": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" }, "templateOptionValues": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } }, "type": "object" }, "SwagCustomizedProductsTemplateExclusionConditionValues": { "required": ["templateExclusionConditionId", "templateOptionValueId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateExclusionConditionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "swagCustomizedProductsTemplateExclusionConditionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionValueId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "swagCustomizedProductsTemplateOptionValueVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "templateExclusionCondition": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" }, "templateOptionValue": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } }, "type": "object" }, "SwagCustomizedProductsTemplateExclusionOperatorJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "operator", "templateOptionType", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "operator": { "type": "string" }, "templateOptionType": { "type": "string" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "templateExclusionConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-exclusion-operator/df2936b0a1e725c8000f04817f4545f7/templateExclusionConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion_condition" }, "id": { "type": "string", "example": "57e853a74b92e339ec2e302b015e60f3" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateExclusionOperator": { "required": ["id", "operator", "templateOptionType", "label"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "operator": { "type": "string" }, "templateOptionType": { "type": "string" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "templateExclusionConditions": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } }, "type": "object" }, "SwagCustomizedProductsTemplateOptionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "type", "templateId", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "typeProperties": { "type": "object" }, "itemNumber": { "type": "string" }, "required": { "type": "boolean" }, "oneTimeSurcharge": { "type": "boolean" }, "relativeSurcharge": { "type": "boolean" }, "advancedSurcharge": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "calculatedPrice": { "type": "object" }, "percentageSurcharge": { "type": "number", "format": "float" }, "templateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { "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": { "prices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option/6342f0c20b443cb5408ec0fc12430bcb/prices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_price" }, "id": { "type": "string", "example": "afae32efe0f84fece3f96b377b768b33" } } } } }, "type": "object" }, "values": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option/6342f0c20b443cb5408ec0fc12430bcb/values" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value" }, "id": { "type": "string", "example": "f09cc7ee3a9a93273f4b80601cafb00c" } } } } }, "type": "object" }, "templateExclusionConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option/6342f0c20b443cb5408ec0fc12430bcb/templateExclusionConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion_condition" }, "id": { "type": "string", "example": "57e853a74b92e339ec2e302b015e60f3" } } } } }, "type": "object" }, "template": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option/6342f0c20b443cb5408ec0fc12430bcb/template" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "66f6181bcb4cff4cd38fbc804a036db6" } } } }, "type": "object" }, "tax": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option/6342f0c20b443cb5408ec0fc12430bcb/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" } ] }, "SwagCustomizedProductsTemplateOption": { "required": ["id", "type", "templateId", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "type": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "typeProperties": { "type": "object" }, "itemNumber": { "type": "string" }, "required": { "type": "boolean" }, "oneTimeSurcharge": { "type": "boolean" }, "relativeSurcharge": { "type": "boolean" }, "advancedSurcharge": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "calculatedPrice": { "type": "object" }, "percentageSurcharge": { "type": "number", "format": "float" }, "templateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { "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" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } }, "templateExclusionConditions": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } }, "template": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" }, "tax": { "$ref": "#/components/schemas/Tax" } }, "type": "object" }, "SwagCustomizedProductsTemplateOptionPriceJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "templateOptionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "percentageSurcharge": { "type": "number", "format": "float" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "templateOption": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-price/a27c46432f56bc59ae059a4bfe5145c0/templateOption" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6891a002a90a39e71e67c4fc148db8df" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-price/a27c46432f56bc59ae059a4bfe5145c0/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" } ] }, "SwagCustomizedProductsTemplateOptionPrice": { "required": ["id", "templateOptionId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "percentageSurcharge": { "type": "number", "format": "float" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "templateOption": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "SwagCustomizedProductsTemplateOptionValueJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "templateOptionId", "position", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "object" }, "displayName": { "type": "string" }, "itemNumber": { "type": "string" }, "default": { "type": "boolean" }, "oneTimeSurcharge": { "type": "boolean" }, "relativeSurcharge": { "type": "boolean" }, "advancedSurcharge": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "calculatedPrice": { "type": "object" }, "percentageSurcharge": { "type": "number", "format": "float" }, "taxId": { "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": { "prices": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value/b57f26a8362182be3e67a815927b7f37/prices" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value_price" }, "id": { "type": "string", "example": "afae32efe0f84fece3f96b377b768b33" } } } } }, "type": "object" }, "templateOption": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value/b57f26a8362182be3e67a815927b7f37/templateOption" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "6891a002a90a39e71e67c4fc148db8df" } } } }, "type": "object" }, "tax": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value/b57f26a8362182be3e67a815927b7f37/tax" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, "templateExclusionConditions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value/b57f26a8362182be3e67a815927b7f37/templateExclusionConditions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_exclusion_condition" }, "id": { "type": "string", "example": "57e853a74b92e339ec2e302b015e60f3" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagCustomizedProductsTemplateOptionValue": { "required": ["id", "templateOptionId", "position", "displayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "value": { "type": "object" }, "displayName": { "type": "string" }, "itemNumber": { "type": "string" }, "default": { "type": "boolean" }, "oneTimeSurcharge": { "type": "boolean" }, "relativeSurcharge": { "type": "boolean" }, "advancedSurcharge": { "type": "boolean" }, "position": { "type": "integer", "format": "int64" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "calculatedPrice": { "type": "object" }, "percentageSurcharge": { "type": "number", "format": "float" }, "taxId": { "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" }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } }, "templateOption": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" }, "tax": { "$ref": "#/components/schemas/Tax" }, "templateExclusionConditions": { "type": "array", "items": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } }, "type": "object" }, "SwagCustomizedProductsTemplateOptionValuePriceJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "templateOptionValueId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionValueId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionValueVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "percentageSurcharge": { "type": "number", "format": "float" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "templateOptionValue": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value-price/db366966e64f89b2bba004a12d76d7af/templateOptionValue" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "376d05104f693cb58e93bed5fe8a7cad" } } } }, "type": "object" }, "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-customized-products-template-option-value-price/db366966e64f89b2bba004a12d76d7af/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" } ] }, "SwagCustomizedProductsTemplateOptionValuePrice": { "required": ["id", "templateOptionValueId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionValueId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "templateOptionValueVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/Price" } }, "percentageSurcharge": { "type": "number", "format": "float" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "templateOptionValue": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "SwagDelayActionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "flowId", "executionTime", "stored"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "eventName": { "type": "string" }, "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "executionTime": { "type": "string", "format": "date-time" }, "expired": { "type": "boolean" }, "delaySequenceId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stored": { "type": "object" }, "errorMessage": { "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": "/swag-delay-action/70d03dd9ed2b3fc83b562c9baae3df7b/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": "/swag-delay-action/70d03dd9ed2b3fc83b562c9baae3df7b/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "flow": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-delay-action/70d03dd9ed2b3fc83b562c9baae3df7b/flow" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, "sequence": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-delay-action/70d03dd9ed2b3fc83b562c9baae3df7b/sequence" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fa1c731ead93e333a9180e16f968c01e" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagDelayAction": { "required": ["id", "flowId", "executionTime", "stored"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "eventName": { "type": "string" }, "flowId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "executionTime": { "type": "string", "format": "date-time" }, "expired": { "type": "boolean" }, "delaySequenceId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stored": { "type": "object" }, "errorMessage": { "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" }, "flow": { "$ref": "#/components/schemas/Flow" }, "sequence": { "$ref": "#/components/schemas/FlowSequence" } }, "type": "object" }, "SwagDynamicAccessCategoryRule": { "required": ["categoryId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "category": { "$ref": "#/components/schemas/Category" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "SwagDynamicAccessLandingPageRule": { "required": ["landingPageId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "landingPage": { "$ref": "#/components/schemas/LandingPage" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "SwagDynamicAccessProductRule": { "required": ["productId", "ruleId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, "rule": { "$ref": "#/components/schemas/Rule" } }, "type": "object" }, "SwagLanguagePackLanguageJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "languageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "administrationActive": { "type": "boolean" }, "salesChannelActive": { "type": "boolean" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "language": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-language-pack-language/a31be60242ded43ddd1a483395e69359/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" } ] }, "SwagLanguagePackLanguage": { "required": ["id", "languageId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "administrationActive": { "type": "boolean" }, "salesChannelActive": { "type": "boolean" }, "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "language": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "SwagMigrationConnectionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "profileName", "gatewayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "credentialFields": { "type": "object", "readOnly": true }, "premapping": { "type": "object" }, "profileName": { "type": "string" }, "gatewayName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "runs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-connection/9b4cd5ca287134a108c3d94d44ed2e05/runs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_run" }, "id": { "type": "string", "example": "878983117a2370e5b702db49786da067" } } } } }, "type": "object" }, "mappings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-connection/9b4cd5ca287134a108c3d94d44ed2e05/mappings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_mapping" }, "id": { "type": "string", "example": "d8e23b791f4ced4d23db067b32520236" } } } } }, "type": "object" }, "settings": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-connection/9b4cd5ca287134a108c3d94d44ed2e05/settings" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_general_setting" }, "id": { "type": "string", "example": "2e5d8aa3dfa8ef34ca5131d20f9dad51" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationConnection": { "required": ["id", "name", "profileName", "gatewayName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "credentialFields": { "type": "object", "readOnly": true }, "premapping": { "type": "object" }, "profileName": { "type": "string" }, "gatewayName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "runs": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationRun" } }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMapping" } }, "settings": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationGeneralSetting" } } }, "type": "object" }, "SwagMigrationDataJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "runId", "entity", "raw"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "entity": { "type": "string" }, "raw": { "type": "object" }, "converted": { "type": "object" }, "unmapped": { "type": "object" }, "mappingUuid": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "written": { "type": "boolean" }, "convertFailure": { "type": "boolean" }, "writeFailure": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "run": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-data/ef2fb6f2b4f336b801810dd506c09a28/run" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_run" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a53108f7543b75adbb34afc035d4cdf6" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationData": { "required": ["id", "runId", "entity", "raw"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "entity": { "type": "string" }, "raw": { "type": "object" }, "converted": { "type": "object" }, "unmapped": { "type": "object" }, "mappingUuid": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "written": { "type": "boolean" }, "convertFailure": { "type": "boolean" }, "writeFailure": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "run": { "$ref": "#/components/schemas/SwagMigrationRun" } }, "type": "object" }, "SwagMigrationGeneralSettingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "selectedConnectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "isReset": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "selectedConnection": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-general-setting/7739a73800e4f4674c4c550f9c2af035/selectedConnection" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_connection" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "82d96df3e87e20b1f52236d17e286761" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationGeneralSetting": { "required": ["id"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "selectedConnectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "isReset": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "selectedConnection": { "$ref": "#/components/schemas/SwagMigrationConnection" } }, "type": "object" }, "SwagMigrationLoggingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "level", "code", "title", "description", "parameters", "titleSnippet", "descriptionSnippet" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "level": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "parameters": { "type": "object" }, "titleSnippet": { "type": "string" }, "descriptionSnippet": { "type": "string" }, "entity": { "type": "string" }, "sourceId": { "type": "string" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "relationships": { "properties": { "run": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-logging/ae841195106900928cb59970ff05b1b2/run" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_run" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a53108f7543b75adbb34afc035d4cdf6" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationLogging": { "required": [ "id", "level", "code", "title", "description", "parameters", "titleSnippet", "descriptionSnippet" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "level": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "parameters": { "type": "object" }, "titleSnippet": { "type": "string" }, "descriptionSnippet": { "type": "string" }, "entity": { "type": "string" }, "sourceId": { "type": "string" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "autoIncrement": { "type": "integer", "format": "int64", "readOnly": true }, "run": { "$ref": "#/components/schemas/SwagMigrationRun" } }, "type": "object" }, "SwagMigrationMappingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "connectionId", "entity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "connectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "oldIdentifier": { "type": "string" }, "entityUuid": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityValue": { "type": "string" }, "checksum": { "type": "string" }, "additionalData": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "connection": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-mapping/804cc61b5d3a72021ea5d6f60fa7a450/connection" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_connection" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "4717d53ebfdfea8477f780ec66151dcb" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationMapping": { "required": ["id", "connectionId", "entity"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "connectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "oldIdentifier": { "type": "string" }, "entityUuid": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityValue": { "type": "string" }, "checksum": { "type": "string" }, "additionalData": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "connection": { "$ref": "#/components/schemas/SwagMigrationConnection" } }, "type": "object" }, "SwagMigrationMediaFileJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "runId", "entity", "uri", "fileName", "fileSize", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "uri": { "type": "string" }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "written": { "type": "boolean" }, "processed": { "type": "boolean" }, "processFailure": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "run": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-media-file/8915313832bc55b48888b768abe6f87c/run" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_run" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a53108f7543b75adbb34afc035d4cdf6" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationMediaFile": { "required": [ "id", "runId", "entity", "uri", "fileName", "fileSize", "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entity": { "type": "string" }, "uri": { "type": "string" }, "fileName": { "type": "string" }, "fileSize": { "type": "integer", "format": "int64" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "written": { "type": "boolean" }, "processed": { "type": "boolean" }, "processFailure": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "run": { "$ref": "#/components/schemas/SwagMigrationRun" } }, "type": "object" }, "SwagMigrationRunJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "step"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "connectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "environmentInformation": { "type": "object" }, "progress": { "required": [ "progress", "total", "currentEntity", "currentEntityProgress", "exceptionCount", "isAborted" ], "properties": { "progress": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" }, "currentEntity": { "type": "string" }, "currentEntityProgress": { "type": "integer", "format": "int64" }, "dataSets": { "type": "array", "items": { "type": "object" } }, "exceptionCount": { "type": "integer", "format": "int64" }, "isAborted": { "type": "boolean" } }, "type": "object" }, "step": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "connection": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-run/dc7ebb549cf146b2f3bc154621cf4d2f/connection" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_connection" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "4717d53ebfdfea8477f780ec66151dcb" } } } }, "type": "object" }, "data": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-run/dc7ebb549cf146b2f3bc154621cf4d2f/data" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_data" }, "id": { "type": "string", "example": "8d777f385d3dfec8815d20f7496026dc" } } } } }, "type": "object" }, "mediaFiles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-run/dc7ebb549cf146b2f3bc154621cf4d2f/mediaFiles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_media_file" }, "id": { "type": "string", "example": "0ff9a5da8eb40da0b7784847ec9d83e8" } } } } }, "type": "object" }, "logs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-migration-run/dc7ebb549cf146b2f3bc154621cf4d2f/logs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_migration_logging" }, "id": { "type": "string", "example": "2165e4fa5bddb65a31f6a0c495c2fa37" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagMigrationRun": { "required": ["id", "step"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "connectionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "environmentInformation": { "type": "object" }, "progress": { "required": [ "progress", "total", "currentEntity", "currentEntityProgress", "exceptionCount", "isAborted" ], "properties": { "progress": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" }, "currentEntity": { "type": "string" }, "currentEntityProgress": { "type": "integer", "format": "int64" }, "dataSets": { "type": "array", "items": { "type": "object" } }, "exceptionCount": { "type": "integer", "format": "int64" }, "isAborted": { "type": "boolean" } }, "type": "object" }, "step": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "connection": { "$ref": "#/components/schemas/SwagMigrationConnection" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationData" } }, "mediaFiles": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationMediaFile" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SwagMigrationLogging" } } }, "type": "object" }, "SwagPaypalPosSalesChannelJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salesChannelId", "apiKey"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "apiKey": { "type": "string" }, "mediaDomain": { "type": "string" }, "webhookSigningKey": { "type": "string" }, "syncPrices": { "type": "boolean" }, "replace": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-pos-sales-channel/132fed17638687e1cc65e90247be70f7/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-pos-sales-channel/132fed17638687e1cc65e90247be70f7/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalPosSalesChannel": { "required": ["id", "salesChannelId", "apiKey"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "apiKey": { "type": "string" }, "mediaDomain": { "type": "string" }, "webhookSigningKey": { "type": "string" }, "syncPrices": { "type": "boolean" }, "replace": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "productStream": { "$ref": "#/components/schemas/ProductStream" } }, "type": "object" }, "SwagPaypalPosSalesChannelInventory": { "required": ["salesChannelId", "productId", "stock"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stock": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "SwagPaypalPosSalesChannelMedia": { "required": ["salesChannelId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lookupKey": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "SwagPaypalPosSalesChannelProduct": { "required": ["salesChannelId", "productId", "checksum"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "checksum": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" } }, "type": "object" }, "SwagPaypalPosSalesChannelRunJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "salesChannelId", "task", "steps"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "task": { "type": "string" }, "status": { "type": "string" }, "messageCount": { "type": "integer", "format": "int64" }, "stepIndex": { "type": "integer", "format": "int64" }, "steps": { "type": "object" }, "finishedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "logs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-pos-sales-channel-run/b76976c435509bec6879d50ac4d90782/logs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_run_log" }, "id": { "type": "string", "example": "2165e4fa5bddb65a31f6a0c495c2fa37" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalPosSalesChannelRun": { "required": ["id", "salesChannelId", "task", "steps"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "task": { "type": "string" }, "status": { "type": "string" }, "messageCount": { "type": "integer", "format": "int64" }, "stepIndex": { "type": "integer", "format": "int64" }, "steps": { "type": "object" }, "finishedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRunLog" } } }, "type": "object" }, "SwagPaypalPosSalesChannelRunLogJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "runId", "level", "message"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "level": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "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": { "posSalesChannelRun": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-pos-sales-channel-run-log/b0323556f4973e4d61a168a39cbed319/posSalesChannelRun" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_pos_sales_channel_run" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "140259e47ae052d4bb99572342db1448" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalPosSalesChannelRunLog": { "required": ["id", "runId", "level", "message"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "runId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "level": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "posSalesChannelRun": { "$ref": "#/components/schemas/SwagPaypalPosSalesChannelRun" } }, "type": "object" }, "SwagPaypalTransactionReportJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["orderTransactionId", "currencyIso", "totalPrice"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyIso": { "type": "string" }, "totalPrice": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "orderTransaction": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-transaction-report/02de0229f33a31b3839208f09069fadd/orderTransaction" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "7d80e6b0ba7e22cf746c767f19873b8f" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalTransactionReport": { "required": ["orderTransactionId", "currencyIso", "totalPrice"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyIso": { "type": "string" }, "totalPrice": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "orderTransaction": { "$ref": "#/components/schemas/OrderTransaction" } }, "type": "object" }, "SwagPaypalVaultTokenJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "customerId", "paymentMethodId", "identifier"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "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": "/swag-paypal-vault-token/fde7456018e5f3d68d7f7cedd814c892/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-vault-token/fde7456018e5f3d68d7f7cedd814c892/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "mainMapping": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-vault-token/fde7456018e5f3d68d7f7cedd814c892/mainMapping" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token_mapping" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e8768174312011419754aa9085d8a9d7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalVaultToken": { "required": ["id", "customerId", "paymentMethodId", "identifier"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "mainMapping": { "$ref": "#/components/schemas/SwagPaypalVaultTokenMapping" } }, "type": "object" }, "SwagPaypalVaultTokenMappingJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["customerId", "paymentMethodId", "tokenId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tokenId": { "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": "/swag-paypal-vault-token-mapping/f80653150e29d7e8e53a0a345ee5a75f/customer" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, "paymentMethod": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-vault-token-mapping/f80653150e29d7e8e53a0a345ee5a75f/paymentMethod" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, "token": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-paypal-vault-token-mapping/f80653150e29d7e8e53a0a345ee5a75f/token" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_paypal_vault_token" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "94a08da1fecbb6e8b46990538c7b50b2" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SwagPaypalVaultTokenMapping": { "required": ["customerId", "paymentMethodId", "tokenId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "tokenId": { "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" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "token": { "$ref": "#/components/schemas/SwagPaypalVaultToken" } }, "type": "object" }, "SwagSequenceWebhookEventLog": { "required": ["sequenceId", "webhookEventLogId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "sequenceId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "webhookEventLogId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "flowSequence": { "$ref": "#/components/schemas/FlowSequence" }, "webhookEventLog": { "$ref": "#/components/schemas/WebhookEventLog" } }, "type": "object" }, "SwagSocialShoppingCustomerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "customerId", "referralCode"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referralCode": { "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": "/swag-social-shopping-customer/dd006533dded680c6de287a39d562c04/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": "/swag-social-shopping-customer/dd006533dded680c6de287a39d562c04/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" } ] }, "SwagSocialShoppingCustomer": { "required": ["id", "customerId", "referralCode"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referralCode": { "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" }, "SwagSocialShoppingOrderJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "orderId", "referralCode"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referralCode": { "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": "/swag-social-shopping-order/dbc494901d9806bb09916e7bc87fa549/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": "/swag-social-shopping-order/dbc494901d9806bb09916e7bc87fa549/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" } ] }, "SwagSocialShoppingOrder": { "required": ["id", "orderId", "referralCode"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referralCode": { "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" }, "SwagSocialShoppingProductErrorJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "productId", "salesChannelId", "errors"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "errors": { "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": "/swag-social-shopping-product-error/da06f26280a08ad5cc8dc81990613070/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": "/swag-social-shopping-product-error/da06f26280a08ad5cc8dc81990613070/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" } ] }, "SwagSocialShoppingProductError": { "required": ["id", "productId", "salesChannelId", "errors"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "errors": { "type": "object" }, "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" }, "SwagSocialShoppingSalesChannelJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "salesChannelId", "salesChannelDomainId", "network" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "network": { "type": "string" }, "configuration": { "type": "object" }, "isValidating": { "type": "boolean" }, "lastValidation": { "type": "string", "format": "date-time" }, "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": "/swag-social-shopping-sales-channel/4fd0d9d0cef562d4ab72dd4b2818e4d9/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, "productStream": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-social-shopping-sales-channel/4fd0d9d0cef562d4ab72dd4b2818e4d9/productStream" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, "salesChannelDomain": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/swag-social-shopping-sales-channel/4fd0d9d0cef562d4ab72dd4b2818e4d9/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": "/swag-social-shopping-sales-channel/4fd0d9d0cef562d4ab72dd4b2818e4d9/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" } ] }, "SwagSocialShoppingSalesChannel": { "required": ["id", "salesChannelId", "salesChannelDomainId", "network"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "network": { "type": "string" }, "configuration": { "type": "object" }, "isValidating": { "type": "boolean" }, "lastValidation": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "productStream": { "$ref": "#/components/schemas/ProductStream" }, "salesChannelDomain": { "$ref": "#/components/schemas/SalesChannelDomain" }, "currency": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "SystemConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "configurationKey", "configurationValue"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { "type": "string" }, "configurationValue": { "properties": { "_value": { "type": "object" } }, "type": "object" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "salesChannel": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/system-config/a59948b9e45358eaaaa1b13d9cedc248/salesChannel" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "SystemConfig": { "description": "Added since version: 6.0.0.0", "required": ["id", "configurationKey", "configurationValue"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { "type": "string" }, "configurationValue": { "properties": { "_value": { "type": "object" } }, "type": "object" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "TagJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "categories": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/categories" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "category" }, "id": { "type": "string", "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" }, "customers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/customers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" }, "orders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/orders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" }, "newsletterRecipients": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/newsletterRecipients" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "newsletter_recipient" }, "id": { "type": "string", "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "type": "object" }, "landingPages": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/landingPages" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "landing_page" }, "id": { "type": "string", "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } } }, "type": "object" }, "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Tag": { "description": "Added since version: 6.0.0.0", "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "subscriptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/subscriptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "subscription" }, "id": { "type": "string", "example": "2d5d14f95af035cbd8437948de61f94c" } } } } }, "type": "object" } }, "type": "object" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } }, "landingPages": { "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } } }, "type": "object" }, "TaxJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "taxRate", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "type": "number", "format": "float" }, "name": { "type": "string" }, "position": { "description": "Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "customizedProductsOptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/customizedProductsOptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "example": "687cffacb8fb6b0e985310daeafaaecc" } } } } }, "type": "object" }, "customizedProductsOptionValues": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/customizedProductsOptionValues" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value" }, "id": { "type": "string", "example": "627d98c94bb4151da667d1e9b26e9807" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" }, "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" }, "shippingMethods": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/shippingMethods" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "shipping_method" }, "id": { "type": "string", "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Tax": { "description": "Added since version: 6.0.0.0", "required": ["id", "taxRate", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "type": "number", "format": "float" }, "name": { "type": "string" }, "position": { "description": "Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "customizedProductsOptions": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/customizedProductsOptions" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option" }, "id": { "type": "string", "example": "687cffacb8fb6b0e985310daeafaaecc" } } } } }, "type": "object" }, "customizedProductsOptionValues": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/customizedProductsOptionValues" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "swag_customized_products_template_option_value" }, "id": { "type": "string", "example": "627d98c94bb4151da667d1e9b26e9807" } } } } }, "type": "object" } }, "type": "object" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethod" } } }, "type": "object" }, "TaxProviderJsonApi": { "description": "Added since version: 6.5.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "identifier", "priority", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "processUrl": { "type": "string" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "availabilityRule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/availabilityRule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxProvider": { "description": "Added since version: 6.5.0.0", "required": ["id", "identifier", "priority", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { "type": "string" }, "active": { "type": "boolean" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "processUrl": { "type": "string" }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "TaxRuleJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "taxRuleTypeId", "countryId", "taxRate", "taxId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "type": "number", "format": "float" }, "data": { "properties": { "states": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "zipCode": { "type": "string" }, "fromZipCode": { "type": "string" }, "toZipCode": { "type": "string" } }, "type": "object" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "type": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/type" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, "country": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/country" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, "tax": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/tax" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxRule": { "description": "Added since version: 6.1.0.0", "required": ["id", "taxRuleTypeId", "countryId", "taxRate", "taxId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { "type": "number", "format": "float" }, "data": { "properties": { "states": { "type": "array", "items": { "type": "object", "additionalProperties": false } }, "zipCode": { "type": "string" }, "fromZipCode": { "type": "string" }, "toZipCode": { "type": "string" } }, "type": "object" }, "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "$ref": "#/components/schemas/TaxRuleType" }, "country": { "$ref": "#/components/schemas/Country" }, "tax": { "$ref": "#/components/schemas/Tax" } }, "type": "object" }, "TaxRuleTypeJsonApi": { "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "technicalName", "position", "typeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string", "readOnly": true }, "position": { "type": "integer", "format": "int64" }, "typeName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "rules": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/tax-rule-type/ebbaa02c602593b9fea23bc0256355fc/rules" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "tax_rule" }, "id": { "type": "string", "example": "a4f86f7bfc24194b276c22e0ef158197" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": ["id", "technicalName", "position", "typeName"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string", "readOnly": true }, "position": { "type": "integer", "format": "int64" }, "typeName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRule" } } }, "type": "object" }, "ThemeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "author", "active"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "description": { "type": "string" }, "labels": { "type": "object" }, "helpTexts": { "type": "object" }, "customFields": { "type": "object" }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentThemeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "themeJson": { "type": "object" }, "baseConfig": { "type": "object" }, "configValues": { "type": "object" }, "active": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "salesChannels": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/salesChannels" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "sales_channel" }, "id": { "type": "string", "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "previewMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/previewMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, "dependentThemes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/dependentThemes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "theme" }, "id": { "type": "string", "example": "f0608e2d62b88d9b9da8d6d715b6439c" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Theme": { "description": "Added since version: 6.0.0.0", "required": ["id", "name", "author", "active"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "technicalName": { "type": "string" }, "name": { "type": "string" }, "author": { "type": "string" }, "description": { "type": "string" }, "labels": { "type": "object" }, "helpTexts": { "type": "object" }, "customFields": { "type": "object" }, "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentThemeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "themeJson": { "type": "object" }, "baseConfig": { "type": "object" }, "configValues": { "type": "object" }, "active": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "salesChannels": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "previewMedia": { "$ref": "#/components/schemas/Media" }, "dependentThemes": { "type": "array", "items": { "$ref": "#/components/schemas/Theme" } } }, "type": "object" }, "ThemeChild": { "description": "Added since version: 6.4.8.0", "required": ["parentId", "childId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "childId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "parentTheme": { "$ref": "#/components/schemas/Theme" }, "childTheme": { "$ref": "#/components/schemas/Theme" } }, "type": "object" }, "ThemeMedia": { "description": "Added since version: 6.0.0.0", "required": ["themeId", "mediaId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "themeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "theme": { "$ref": "#/components/schemas/Theme" }, "media": { "$ref": "#/components/schemas/Media" } }, "type": "object" }, "ThemeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": ["salesChannelId", "themeId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "themeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "theme": { "$ref": "#/components/schemas/Theme" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, "UnitJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "shortCode", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "relationships": { "properties": { "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/unit/19c562a36aeb455d09534f93b4f5236f/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Unit": { "description": "Added since version: 6.0.0.0", "required": ["id", "shortCode", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { "type": "string" }, "name": { "type": "string" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "translated": { "type": "object" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "UserJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "localeId", "username", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "email": { "type": "string" }, "active": { "type": "boolean" }, "admin": { "type": "boolean" }, "lastUpdatedPasswordAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" }, "customFields": { "type": "object" }, "avatarId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "orderReturnsCreated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "727aaaa1b237ca288bd73419446975b4" } } } } }, "type": "object" }, "orderReturnsUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "b236f1d18dddb0c2a359d93c25da5a20" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quotesUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "58ff54114372ffbca7305b48fa25f8fc" } } } } }, "type": "object" }, "quotesAssignee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "1b848b0267abc056ed84fb16cb26f60a" } } } } }, "type": "object" }, "createdQuoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "860bc13329c5b039ddeccbd9cced778d" } } } } }, "type": "object" }, "cmsPageDrafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/cmsPageDrafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "93c0df75844858f2b2a9359abc152f5d" } } } } }, "type": "object" }, "cmsPageActivities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/cmsPageActivities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_activity" }, "id": { "type": "string", "example": "aae7ba0db81d03df86e789e3f6cf8fe5" } } } } }, "type": "object" }, "dsrAppointmentGuideUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "e8e8e4db862bed157007764e46f5aecb" } } } } }, "type": "object" }, "createdPresentations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "example": "d1e11035d87216918d95e78a7ac396da" } } } } }, "type": "object" }, "updatedPresentations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "example": "49fb9c4fad69d4a3da998a936016c88d" } } } } }, "type": "object" }, "createdAppointments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "888e350c3c9a465bc4d7c8a80840b2aa" } } } } }, "type": "object" }, "updatedAppointments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "b64277a1e650794e2c57924c07825014" } } } } }, "type": "object" }, "createdLayouts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "example": "22b76a69d00feab60733ea096895a432" } } } } }, "type": "object" }, "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" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" }, "shoppingListsUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingListsUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "c47bfa46d7fba9695703a588a4aa19fb" } } } } }, "type": "object" } }, "type": "object" }, "relationships": { "properties": { "locale": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/locale" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, "avatarMedia": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/avatarMedia" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "117ab0b986d2b792c775e3beeacca7c7" } } } }, "type": "object" }, "media": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/media" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "media" }, "id": { "type": "string", "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } } }, "type": "object" }, "accessKeys": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/accessKeys" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user_access_key" }, "id": { "type": "string", "example": "d11944e47e101a4aaa8d7947faa56b16" } } } } }, "type": "object" }, "configs": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/configs" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "user_config" }, "id": { "type": "string", "example": "c23f7ab876ac167e05468ef79f046cb7" } } } } }, "type": "object" }, "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/stateMachineHistoryEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "state_machine_history" }, "id": { "type": "string", "example": "c78c7ea361b7def0876b75bd1bd37879" } } } } }, "type": "object" }, "importExportLogEntries": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/importExportLogEntries" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "import_export_log" }, "id": { "type": "string", "example": "72ec794255f368c7a704e177fa9a4967" } } } } }, "type": "object" }, "aclRoles": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/aclRoles" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "acl_role" }, "id": { "type": "string", "example": "e050a8081a3eb1d193c23cf0ef761183" } } } } }, "type": "object" }, "recoveryUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/recoveryUser" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "bf6cdb5c30f0f0d234b96e50f2953109" } } } }, "type": "object" }, "createdOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "20509127ddf2655eb49e3db3b1d710c0" } } } } }, "type": "object" }, "updatedOrders": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedOrders" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order" }, "id": { "type": "string", "example": "9ce34a8be6d860e8bd92feaf79e9a4a2" } } } } }, "type": "object" }, "createdCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "c0caccfe18ce8c277f15d100818139a6" } } } } }, "type": "object" }, "updatedCustomers": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedCustomers" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "customer" }, "id": { "type": "string", "example": "dddac98f88e37eb31b56e7e1d455fd75" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "User": { "description": "Added since version: 6.0.0.0", "required": [ "id", "localeId", "username", "firstName", "lastName", "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "email": { "type": "string" }, "active": { "type": "boolean" }, "admin": { "type": "boolean" }, "lastUpdatedPasswordAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" }, "customFields": { "type": "object" }, "avatarId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "orderReturnsCreated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "727aaaa1b237ca288bd73419446975b4" } } } } }, "type": "object" }, "orderReturnsUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_return" }, "id": { "type": "string", "example": "b236f1d18dddb0c2a359d93c25da5a20" } } } } }, "type": "object" }, "quotes": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" }, "quotesUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "58ff54114372ffbca7305b48fa25f8fc" } } } } }, "type": "object" }, "quotesAssignee": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote" }, "id": { "type": "string", "example": "1b848b0267abc056ed84fb16cb26f60a" } } } } }, "type": "object" }, "createdQuoteComments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "quote_comment" }, "id": { "type": "string", "example": "860bc13329c5b039ddeccbd9cced778d" } } } } }, "type": "object" }, "cmsPageDrafts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/cmsPageDrafts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_draft" }, "id": { "type": "string", "example": "93c0df75844858f2b2a9359abc152f5d" } } } } }, "type": "object" }, "cmsPageActivities": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/cmsPageActivities" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page_activity" }, "id": { "type": "string", "example": "aae7ba0db81d03df86e789e3f6cf8fe5" } } } } }, "type": "object" }, "dsrAppointmentGuideUser": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "e8e8e4db862bed157007764e46f5aecb" } } } } }, "type": "object" }, "createdPresentations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "example": "d1e11035d87216918d95e78a7ac396da" } } } } }, "type": "object" }, "updatedPresentations": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_presentation" }, "id": { "type": "string", "example": "49fb9c4fad69d4a3da998a936016c88d" } } } } }, "type": "object" }, "createdAppointments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "888e350c3c9a465bc4d7c8a80840b2aa" } } } } }, "type": "object" }, "updatedAppointments": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "dsr_appointment" }, "id": { "type": "string", "example": "b64277a1e650794e2c57924c07825014" } } } } }, "type": "object" }, "createdLayouts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "cms_page" }, "id": { "type": "string", "example": "22b76a69d00feab60733ea096895a432" } } } } }, "type": "object" }, "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" }, "shoppingLists": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingLists" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "efa2c2d016771a1e072e6b05091fb584" } } } } }, "type": "object" }, "shoppingListsUpdated": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingListsUpdated" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "b2b_components_shopping_list" }, "id": { "type": "string", "example": "c47bfa46d7fba9695703a588a4aa19fb" } } } } }, "type": "object" } }, "type": "object" }, "locale": { "$ref": "#/components/schemas/Locale" }, "avatarMedia": { "$ref": "#/components/schemas/Media" }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "accessKeys": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessKey" } }, "configs": { "type": "array", "items": { "$ref": "#/components/schemas/UserConfig" } }, "stateMachineHistoryEntries": { "type": "array", "items": { "$ref": "#/components/schemas/StateMachineHistory" } }, "importExportLogEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ImportExportLog" } }, "aclRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AclRole" } }, "recoveryUser": { "$ref": "#/components/schemas/UserRecovery" }, "createdOrders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "updatedOrders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "createdCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "updatedCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } } }, "type": "object" }, "UserAccessKeyJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "userId", "accessKey", "secretAccessKey"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { "type": "string" }, "secretAccessKey": { "type": "string" }, "lastUsageAt": { "type": "string", "format": "date-time" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-access-key/01614dd7e96bd79868128dca72e7eff8/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserAccessKey": { "description": "Added since version: 6.0.0.0", "required": ["id", "userId", "accessKey", "secretAccessKey"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { "type": "string" }, "secretAccessKey": { "type": "string" }, "lastUsageAt": { "type": "string", "format": "date-time" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "UserConfigJsonApi": { "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "userId", "key"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { "type": "string" }, "value": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-config/4b55408b66d30e27bb1593401072cd70/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserConfig": { "description": "Added since version: 6.3.5.0", "required": ["id", "userId", "key"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { "type": "string" }, "value": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "UserRecoveryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "hash", "userId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "user": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/user-recovery/f451cbc27abefae127822d81c5dbb338/user" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "UserRecovery": { "description": "Added since version: 6.0.0.0", "required": ["id", "hash", "userId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "WarehouseJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "productWarehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/productWarehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product_warehouse" }, "id": { "type": "string", "example": "ff6147ec4fdd4e27441a0439366d0e4d" } } } } }, "type": "object" }, "groups": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/groups" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse_group" }, "id": { "type": "string", "example": "1471e4e05a4db95d353cc867fe317314" } } } } }, "type": "object" }, "orderProducts": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/orderProducts" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "order_product_warehouse" }, "id": { "type": "string", "example": "5b044c586b7768148276b8d5c4ef61b6" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Warehouse": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "productWarehouses": { "type": "array", "items": { "$ref": "#/components/schemas/ProductWarehouse" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseGroup" } }, "orderProducts": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductWarehouse" } } }, "type": "object" }, "WarehouseGroupJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "rule": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/rule" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, "warehouses": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/warehouses" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "warehouse" }, "id": { "type": "string", "example": "544959798565126142ca2820b4f56271" } } } } }, "type": "object" }, "products": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/products" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "product" }, "id": { "type": "string", "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "WarehouseGroup": { "required": ["id", "name"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "integer", "format": "int64" }, "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "rule": { "$ref": "#/components/schemas/Rule" }, "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } }, "type": "object" }, "WarehouseGroupWarehouse": { "required": ["warehouseId", "warehouseGroupId"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "warehouseGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { "type": "integer", "format": "int64" }, "warehouseGroup": { "$ref": "#/components/schemas/WarehouseGroup" }, "warehouse": { "$ref": "#/components/schemas/Warehouse" } }, "type": "object" }, "WebhookJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": ["id", "name", "eventName", "url"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "eventName": { "type": "string" }, "url": { "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "errorCount": { "type": "integer", "format": "int64", "readOnly": true }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "relationships": { "properties": { "app": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/webhook/150c7abfca6c489fee5cb82fbb7a9bc4/app" } } }, "data": { "type": "object", "properties": { "type": { "type": "string", "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "Webhook": { "description": "Added since version: 6.3.1.0", "required": ["id", "name", "eventName", "url"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, "eventName": { "type": "string" }, "url": { "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "errorCount": { "type": "integer", "format": "int64", "readOnly": true }, "active": { "type": "boolean" }, "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, "WebhookEventLogJsonApi": { "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ "id", "webhookName", "eventName", "deliveryStatus", "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "webhookName": { "type": "string" }, "eventName": { "type": "string" }, "deliveryStatus": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" }, "processingTime": { "type": "integer", "format": "int64" }, "appVersion": { "type": "string" }, "requestContent": { "type": "object" }, "responseContent": { "type": "object" }, "responseStatusCode": { "type": "integer", "format": "int64" }, "responseReasonPhrase": { "type": "string" }, "url": { "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "WebhookEventLog": { "description": "Added since version: 6.4.1.0", "required": ["id", "webhookName", "eventName", "deliveryStatus", "url"], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appName": { "type": "string" }, "webhookName": { "type": "string" }, "eventName": { "type": "string" }, "deliveryStatus": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" }, "processingTime": { "type": "integer", "format": "int64" }, "appVersion": { "type": "string" }, "requestContent": { "type": "object" }, "responseContent": { "type": "object" }, "responseStatusCode": { "type": "integer", "format": "int64" }, "responseReasonPhrase": { "type": "string" }, "url": { "type": "string" }, "onlyLiveVersion": { "type": "boolean" }, "customFields": { "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "extensions": { "properties": { "flowSequences": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", "format": "uri-reference", "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "flow_sequence" }, "id": { "type": "string", "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", "properties": { "page": { "description": "Search result page", "type": "integer" }, "limit": { "description": "Number of items per result page", "type": "integer" }, "filter": { "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } }, "sort": { "type": "array", "description": "Sorting in the search result.", "items": { "type": "object", "properties": { "field": { "type": "string" }, "order": { "type": "string" }, "naturalSorting": { "type": "boolean" } }, "required": ["field"] } }, "post-filter": { "type": "array", "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } }, "associations": { "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", "items": { "$ref": "#/components/schemas/Aggregation" } }, "grouping": { "type": "array", "description": "Perform groupings over certain fields", "items": { "type": "string", "description": "Name of a field" } }, "fields": { "type": "array", "description": "Fields which should be returned in the search result.", "items": { "type": "string", "description": "Name of a field" } }, "total-count-mode": { "description": "Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)", "type": "string", "default": "none", "enum": ["none", "exact", "next-pages"] }, "ids": { "type": "array", "description": "List of ids to search for", "items": { "type": "string" } }, "includes": { "$ref": "#/components/schemas/Includes" }, "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.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Excludes": { "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "Filters": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilter" }, { "$ref": "#/components/schemas/EqualsFilter" }, { "$ref": "#/components/schemas/MultiNotFilter" }, { "$ref": "#/components/schemas/RangeFilter" } ] } }, "SimpleFilter": { "anyOf": [ { "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"] }, "MeasurementUnits": { "type": "object", "description": "Configuration of the measurement system", "properties": { "system": { "type": "string", "enum": ["metric", "imperial"], "default": "metric", "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, "units": { "type": "object", "description": "Units used in the measurement system.", "properties": { "length": { "type": "string", "enum": ["mm", "cm", "m", "in", "ft"], "default": "mm", "description": "Unit of length." }, "weight": { "type": "string", "enum": ["g", "kg", "oz", "lb"], "default": "kg", "description": "Unit of weight." } } } } }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", "enum": [ "write", "user-verified", "admin", "write user-verified", "write admin", "user-verified admin", "write user-verified admin" ] }, "OAuthGrant": { "type": "object", "properties": { "grant_type": { "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", "type": "string" } }, "required": ["grant_type"], "discriminator": { "propertyName": "grant_type", "mapping": { "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", "password": "#/components/schemas/OAuthPasswordGrant", "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" } } }, "OAuthClientCredentialsGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string" }, "client_secret": { "description": "Password of the client that should be authenticated.", "type": "string" } }, "required": ["client_id", "client_secret"] } ] }, "OAuthPasswordGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string", "enum": ["administration"] }, "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "username": { "description": "Username of the user that should be authenticated.", "type": "string" }, "password": { "description": "Password of the user that should be authenticated.", "type": "string" } }, "required": ["client_id", "scope", "username", "password"] } ] }, "OAuthRefreshTokenGrant": { "allOf": [ { "$ref": "#/components/schemas/OAuthGrant" }, { "type": "object", "properties": { "client_id": { "description": "OAuth client id.", "type": "string", "enum": ["administration"] }, "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "refresh_token": { "description": "The refresh token that should be used to refresh the access token.", "type": "string" } }, "required": ["client_id", "scope", "refresh_token"] } ] }, "Price": { "type": "object", "description": "Price object", "properties": { "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "", "type": "number" }, "net": { "description": "", "type": "number" }, "linked": { "description": "", "type": "boolean" }, "listPrice": { "description": "", "type": "object", "properties": { "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "", "type": "number" }, "net": { "description": "", "type": "number" }, "linked": { "description": "", "type": "boolean" } }, "required": ["gross", "net", "linked"] }, "regulationPrice": { "description": "", "type": "object", "properties": { "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "description": "", "type": "number" }, "net": { "description": "", "type": "number" }, "linked": { "description": "", "type": "boolean" } }, "required": ["gross", "net", "linked"] } }, "required": ["currencyId", "gross", "net", "linked"] }, "businessEventsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the event" }, "class": { "type": "string", "description": "Class name of the event" }, "data": { "type": "object", "description": "Available data of event" }, "aware": { "type": "array", "description": "Flow builder will base on awareness to show actions", "items": { "type": "string" } }, "extensions": { "type": "array", "description": "Extensions data of event", "items": { "type": "string" } } } } }, "flowBuilderActionsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the flow action" }, "requirements": { "type": "array", "description": "When requirement fit with aware from `events.json` actions will be shown", "items": { "type": "string" } }, "extensions": { "type": "array", "items": { "type": "string" }, "description": "Extensions data of event" } } } }, "infoConfigResponse": { "type": "object", "properties": { "version": { "type": "string", "description": "Shopware version." }, "shopId": { "type": "string", "description": "Unique shop identifier." }, "versionRevision": { "type": "string", "description": "Shopware version revision (build hash/revision)." }, "adminWorker": { "type": "object", "description": "Admin worker feature flags and transport configuration.", "properties": { "enableAdminWorker": { "type": "boolean", "description": "Whether the admin background worker is enabled." }, "enableQueueStatsWorker": { "type": "boolean", "description": "Whether the queue statistics worker is enabled." }, "enableNotificationWorker": { "type": "boolean", "description": "Whether the notification worker is enabled." }, "transports": { "type": "array", "description": "Configured Symfony Messenger transports used by the admin workers.", "items": { "type": "string" } } }, "additionalProperties": false }, "bundles": { "type": "object", "description": "Active extension assets (plugins & apps) keyed by technical name.", "additionalProperties": { "oneOf": [ { "type": "object", "description": "Plugin bundle asset descriptor.", "properties": { "type": { "type": "string", "enum": ["plugin"] }, "css": { "type": "array", "items": { "type": "string", "description": "URL to a CSS asset." } }, "js": { "type": "array", "items": { "type": "string", "description": "URL to a JS asset." } }, "baseUrl": { "type": ["string", "null"], "description": "Base URL to a (micro frontend) admin entry point, if provided." } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "description": "App bundle descriptor.", "properties": { "type": { "type": "string", "enum": ["app"] }, "name": { "type": "string" }, "active": { "type": "boolean" }, "integrationId": { "type": "string", "description": "Lowercase hex integration id." }, "baseUrl": { "type": "string" }, "version": { "type": "string" }, "permissions": { "type": "object", "description": "Grouped privileges: key = privilege scope, value = list of entities.", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "css": { "type": "array", "items": { "type": "string" }, "description": "Optional CSS assets if provided." }, "js": { "type": "array", "items": { "type": "string" }, "description": "Optional JS assets if provided." } }, "required": [ "type", "name", "active", "integrationId", "baseUrl", "version", "permissions" ], "additionalProperties": false } ] } }, "settings": { "type": "object", "description": "Selected environment and feature settings consumed by the administration.", "properties": { "enableUrlFeature": { "type": "boolean", "description": "State of the URL upload feature." }, "appUrlReachable": { "type": "boolean", "description": "Whether configured APP_URL is externally reachable." }, "appsRequireAppUrl": { "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", "items": { "type": "string" } }, "enableHtmlSanitizer": { "type": "boolean", "description": "Whether HTML sanitizer is enabled." }, "enableStagingMode": { "type": "boolean", "description": "Whether staging mode banner is enabled." }, "disableExtensionManagement": { "type": "boolean", "description": "True if runtime extension management is disabled." } }, "additionalProperties": false }, "inAppPurchases": { "type": "array", "description": "In-app purchase meta data (structure may vary).", "items": { "type": "object", "description": "Purchase entry.", "additionalProperties": true } } }, "required": [ "version", "shopId", "versionRevision", "adminWorker", "bundles", "settings", "inAppPurchases" ], "additionalProperties": false }, "CustomPricingDeleteOperation": { "type": "object", "required": ["action", "payload"], "properties": { "action": { "description": "A specific verb defining what operation should be actioned for a specific data record", "type": "string", "enum": ["delete"] }, "payload": { "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", "type": "array", "items": { "anyOf": [ { "title": "productIds", "type": "array", "description": "An array of product entity UUIDs", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "title": "customerIds", "type": "array", "description": "An array of customer entity UUIDs", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, { "title": "customerGroupIds", "type": "array", "description": "An array of customerGroup entity UUIDs", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } } ] } } } }, "CustomPricingPrice": { "type": "object", "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", "required": ["quantityStart", "price"], "properties": { "quantityStart": { "type": "integer", "format": "int64" }, "quantityEnd": { "type": "integer", "format": "int64", "minimum": 1 }, "price": { "type": "array", "items": { "type": "object", "description": "This field should house all the normal facets of the `product_price`.`price` column", "required": ["currencyId", "gross", "net", "linked"], "properties": { "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { "type": "number", "minimum": 0 }, "net": { "type": "number", "minimum": 0 }, "linked": { "type": "boolean" }, "listPrice": { "type": "object", "properties": { "gross": { "type": "number", "minimum": 0 }, "net": { "type": "number", "minimum": 0 }, "linked": { "type": "boolean" } } }, "regulationPrice": { "type": "object", "properties": { "gross": { "type": "number", "minimum": 0 }, "net": { "type": "number", "minimum": 0 }, "linked": { "type": "boolean" } } } } } } } }, "CustomPricingResponse": { "type": "object", "required": ["success", "data"], "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "required": ["entities", "errors"], "properties": { "entities": { "type": "array", "maxItems": 1, "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, "errors": { "type": "array", "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", "items": { "type": "string" } } } } }, "extensions": { "type": "array", "items": { "type": "object" } } } } } } }, "CustomPricingUpsertOperation": { "type": "object", "required": ["action", "payload"], "properties": { "action": { "description": "A specific verb defining what operation should be actioned for a specific data record", "type": "string", "enum": ["upsert"] }, "payload": { "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", "type": "array", "items": { "type": "object", "required": ["productId", "prices"], "description": "A definition almost symmetric with Sync API payload", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerId": { "type": "string", "description": "This parameter should be specified, or 'customerGroupId', not both", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { "type": "string", "description": "This parameter should be specified, or 'customerId', not both", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", "items": { "$ref": "#/components/schemas/CustomPricingPrice" } } } } } } }, "Options": { "type": "object", "properties": { "mood": { "type": "string", "enum": ["positive", "neutral"], "description": "Tone/mood to guide summary generation (optional)." }, "productId": { "type": "string", "description": "Product UUID (hex) identifying the product to generate summaries for. This field is required." }, "salesChannelId": { "type": "string", "description": "Sales channel UUID (hex) used to scope generation and locale/context resolution. This field is required." }, "languageIds": { "type": "array", "items": { "type": "string" }, "description": "Array of language UUIDs (hex). Provided language IDs will be mapped to locale codes server-side; supply this OR `locales`." }, "locales": { "type": "array", "items": { "type": "string" }, "description": "Array of locale codes (e.g. `de-DE`, `en-GB`). Supply this OR `languageIds`. At least one of `languageIds` or `locales` must be present." }, "length": { "type": "integer", "description": "Desired length of the generated summary in number of characters (optional, default: 300)." }, "reviews": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "content": { "type": "string" }, "points": { "type": "string" } }, "required": ["title", "content", "points"], "description": "Array of review objects containing title, content, and points (optional, if not provided, reviews will be fetched from product)." } } }, "required": ["productId", "salesChannelId"], "anyOf": [{ "required": ["languageIds"] }, { "required": ["locales"] }], "additionalProperties": true, "description": "Options object passed to Review Summary generation." }, "ReviewSummaryItem": { "type": "object", "properties": { "languageId": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": true }, "ReviewSummaryByLanguage": { "type": "object", "additionalProperties": { "type": "string", "description": "Generated summary for the language id" }, "description": "Map of languageId to generated summary string." }, "AbstractDynamicPageOpenedPayload": { "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "description": "The type of the current dynamic page" }, "opened": { "type": "boolean", "default": true } } }, "AttendeeInsights": { "type": "object", "description": "Attendee Insights", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Id of the attendee" }, "cartSum": { "type": "number", "description": "Sum of the cart net in base currency" }, "productCount": { "type": "number", "description": "Sum of all quantities in the cart which were added during the appointment" } }, "example": { "04da9d8572494ae68391a471d4c3a470": { "extensions": [], "id": "04da9d8572494ae68391a471d4c3a470", "cartSum": 6770.53, "productCount": 3, "lineItemCount": 3 } } }, "CalculatedPrice": { "type": "object", "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { "unitPrice": { "type": "number" }, "quantity": { "type": "number" }, "rawTotal": { "type": "number" }, "totalPrice": { "type": "number" }, "calculatedTaxes": { "type": "array", "items": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["cart_tax_calculated"] }, "tax": { "type": "number" }, "taxRate": { "type": "number" }, "price": { "type": "number" } }, "required": ["apiAlias", "tax", "taxRate", "price"] } }, "referencePrice": { "oneOf": [ { "$ref": "#/components/schemas/CartPriceReference" }, { "type": "null" } ] }, "listPrice": { "oneOf": [ { "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } ] }, "positionPrice": { "type": "number" }, "netPrice": { "type": "number" }, "regulationPrice": { "type": "object", "properties": { "price": { "type": "number" }, "apiAlias": { "type": "string", "enum": ["cart_regulation_price"] } }, "nullable": true }, "hasRange": { "type": "boolean" }, "variantId": { "type": "string", "format": "^[0-9a-f]{32}$", "nullable": true }, "apiAlias": { "type": "string", "enum": ["calculated_price"] }, "taxRules": { "type": "array", "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { "taxRate": { "type": "number", "format": "float" }, "name": { "type": "string" } } } } }, "required": [ "apiAlias", "hasRange", "regulationPrice", "listPrice", "referencePrice", "calculatedTaxes", "totalPrice", "quantity", "unitPrice", "positionPrice", "netPrice", "taxRules" ] }, "Cart": { "type": "object", "properties": { "name": { "description": "Name of the cart - for example `guest-cart`", "type": "string" }, "token": { "description": "Context token identifying the cart and the user session", "type": "string" }, "price": { "$ref": "#/components/schemas/CalculatedPrice" }, "lineItems": { "description": "All items within the cart", "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } }, "errors": { "type": "array", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { "$ref": "#/components/schemas/CartError" } }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/CartDelivery" } }, "transactions": { "description": "A list of all payment transactions associated with the current cart.", "type": "array", "items": { "type": "object", "properties": { "paymentMethodId": { "type": "string" }, "amount": { "$ref": "#/components/schemas/CalculatedPrice" } } } }, "modified": { "type": "boolean" }, "customerComment": { "type": "string", "description": "A comment that can be added to the cart.", "nullable": true }, "affiliateCode": { "type": "string", "description": "An affiliate tracking code", "nullable": true }, "campaignCode": { "type": "string", "description": "A campaign tracking code", "nullable": true } } }, "CartDelivery": { "type": "object", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { "deliveryDate": { "type": "object", "properties": { "earliest": { "type": "string", "format": "date-time" }, "latest": { "type": "string", "format": "date-time" } } }, "location": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["cart_delivery_shipping_location"] }, "country": { "$ref": "#/components/schemas/Country" }, "address": { "$ref": "#/components/schemas/CustomerAddress" }, "state": { "$ref": "#/components/schemas/CountryState" } } }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/CartDeliveryPosition" } }, "shippingCosts": { "$ref": "#/components/schemas/CalculatedPrice" }, "shippingMethod": { "$ref": "#/components/schemas/ShippingMethod" } } }, "CartDeliveryInformation": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["cart_delivery_information"] }, "freeDelivery": { "type": "boolean" }, "deliveryTime": { "type": "object", "properties": { "name": { "type": "string" }, "min": { "type": "integer" }, "max": { "type": "integer" }, "unit": { "type": "string" }, "apiAlias": { "type": "string", "enum": ["cart_delivery_time"] } } }, "height": { "type": "integer" }, "length": { "type": "integer" }, "restockTime": { "type": "integer" }, "stock": { "type": "integer" }, "weight": { "type": "integer" }, "width": { "type": "integer" } }, "required": ["apiAlias"] }, "CartDeliveryPosition": { "type": "object", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { "deliveryDate": { "type": "object", "properties": { "earliest": { "type": "string", "format": "date-time" }, "latest": { "type": "string", "format": "date-time" } } }, "identifier": { "type": "string" }, "lineItem": { "$ref": "#/components/schemas/LineItem" }, "price": { "$ref": "#/components/schemas/CalculatedPrice" } } }, "CartError": { "type": "object", "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { "items": { "type": "object", "properties": { "key": { "type": "string" }, "level": { "type": "number", "enum": [0, 10, 20], "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" }, "message": { "type": "string" }, "messageKey": { "type": "string" } } } } }, "CartItems": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } } } }, "CartListPrice": { "type": "object", "description": "", "properties": { "discount": { "type": "number" }, "percentage": { "type": "number" }, "price": { "type": "number" }, "apiAlias": { "type": "string", "enum": ["cart_list_price"] } }, "required": ["apiAlias"] }, "CartPriceQuantity": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["cart_price_quantity"] }, "isCalculated": { "type": "boolean" }, "listPrice": { "$ref": "#/components/schemas/CartListPrice" }, "price": { "type": "number" }, "quantity": { "type": "number" }, "regulationPrice": { "properties": { "price": { "type": "number", "format": "float" } }, "type": "object" }, "taxRules": { "type": "array", "items": { "type": "object", "properties": { "taxRate": { "type": "number", "format": "float" }, "name": { "type": "string" } } } }, "type": { "type": "string" } }, "required": ["apiAlias"] }, "CartPriceReference": { "type": "object", "properties": { "purchaseUnit": { "type": "number" }, "referenceUnit": { "type": "number" }, "unitName": { "type": "string" }, "price": { "type": "number" }, "apiAlias": { "type": "string", "enum": ["cart_price_reference"] }, "listPrice": { "oneOf": [ { "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } ] }, "regulationPrice": { "type": "object", "properties": { "price": { "type": "number" }, "apiAlias": { "type": "string", "enum": ["cart_regulation_price"] } }, "nullable": true }, "hasRange": { "type": "boolean" }, "variantId": { "type": "string", "format": "^[0-9a-f]{32}$", "nullable": true } }, "required": [ "apiAlias", "hasRange", "regulationPrice", "listPrice", "calculatedTaxes", "totalPrice", "quantity", "unitName" ] }, "DiscountType": { "type": "string", "description": "Type of the discount", "enum": ["percentage", "absolute"] }, "AddTempDiscountRequestBody": { "type": "object", "required": ["discountType", "discountValue", "appliedItemIds"], "properties": { "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "description": "Value of the discount (leave it 0 if you want to remove the discount)", "maximum": 0 }, "appliedItemIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "description": "Ids of the items to which the discount should be applied" } } }, "AddCartDiscountRequestBody": { "type": "object", "required": ["discountType", "discountValue"], "properties": { "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "description": "Value of the discount (leave it 0 if you want to remove the discount)", "maximum": 0 } } }, "DynamicPageOpenedPayload": { "allOf": [ { "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" } ] }, "DynamicProductListingPageOpenedPayload": { "required": ["page"], "properties": { "page": { "type": "integer", "description": "Current page position in the pagination" } } }, "GetAttendeeInsightsResponse": { "type": "object", "description": "Returns aggregations for the current attendees within the appointment.", "properties": { "attendees": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AttendeeInsights" } }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencySymbol": { "type": "string" } }, "example": { "extensions": [], "attendees": { "04da9d8572494ae68391a471d4c3a470": { "extensions": [], "id": "04da9d8572494ae68391a471d4c3a470", "cartSum": 6770.53, "productCount": 3, "lineItemCount": 3 } }, "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", "currencySymbol": "$" } }, "GetCartInsightsResponse": { "type": "object", "description": "Returns aggregations for the current carts within the appointment.", "properties": { "cartSum": { "type": "number", "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, "productCount": { "type": "number", "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id from the shown currency" }, "currencySymbol": { "type": "string", "description": "The currency symbol from the shown currency" }, "topProducts": { "type": "object", "required": ["byQuantity", "byRevenue"], "properties": { "byQuantity": { "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id from the product" }, "value": { "type": "number", "description": "The quantity in carts of this product" } }, "required": ["productId", "value"] } }, "byRevenue": { "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id from the product" }, "value": { "type": "number", "description": "The net revenue in the shown currency in carts of this product" } }, "required": ["productId", "value"] } } } } }, "example": { "extensions": [], "cartSum": 6770.53, "productCount": 3, "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", "currencySymbol": "$", "topProducts": { "byQuantity": [ { "productId": "01ae0dee60ea48fdafaf881b96361d59", "value": 1 }, { "productId": "fee3ca762be94bb49b692e359d529563", "value": 1 }, { "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", "value": 1 } ], "byRevenue": [ { "productId": "fee3ca762be94bb49b692e359d529563", "value": 5333.03 }, { "productId": "01ae0dee60ea48fdafaf881b96361d59", "value": 1152.62 }, { "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", "value": 284.88 } ] } } }, "GetListBodyRequest": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Max amount of resources to be returned in a page" }, "page": { "type": "integer", "description": "The page to be returned" } } }, "GuidePresentationStateResponse": { "type": "object", "properties": { "stateForAll": { "$ref": "#/components/schemas/StateForAll" }, "stateForClients": { "$ref": "#/components/schemas/StateForGuides" } }, "example": { "extensions": [], "stateForAll": { "currentGuideProductId": null, "lastActiveGuideSection": null, "currentPageId": null, "currentSectionId": null, "currentSlideAlias": 0, "currentDynamicPage": null, "started": false, "running": false, "ended": false, "startedAt": null, "endedAt": null, "accessibleFrom": { "date": "2023-08-04 00:00:00.000000", "timezone_type": 3, "timezone": "UTC" }, "accessibleTo": { "date": "2023-08-05 00:00:00.000000", "timezone_type": 3, "timezone": "UTC" }, "appointmentMode": "guided", "videoAudioSettings": "both", "videoRoomUrl": "", "attendeeRestrictionType": "open", "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", "broadcastMode": false, "extensions": [] }, "stateForGuides": { "clients": [], "inactiveClients": { "2b4066cd37a341088e32a81e04a56817": { "attendeeId": "2b4066cd37a341088e32a81e04a56817", "attendeeName": "Attendee 1", "videoUserId": null, "hasJoined": false }, "302108ad602b4ac687f5247aae5d0297": { "attendeeId": "302108ad602b4ac687f5247aae5d0297", "attendeeName": null, "videoUserId": null, "hasJoined": true }, "5a3b4e84acab47119b8a6bceb79e732e": { "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", "attendeeName": "Test attende name", "videoUserId": null, "hasJoined": true }, "b6358241e4ad4a4e99d0f729d21d63be": { "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", "attendeeName": null, "videoUserId": null, "hasJoined": true }, "f1bb9374308d4e088c29d10a2fc8cc07": { "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", "attendeeName": null, "videoUserId": null, "hasJoined": false } }, "guides": { "1850bbdc12dc44aba95bc78b16c3643c": { "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", "attendeeName": " admin", "videoUserId": null, "hasJoined": true } }, "videoGuideToken": null, "quickViewState": [], "extensions": [] } } }, "JoinAppointmentResponse": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", "properties": { "mercureSubscriberTopics": { "type": "array", "items": { "type": "string", "description": "mercure topic" }, "description": "The topics to which the attendee/guide can subscribe for" }, "mercurePublisherTopic": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The topic to which the attendee/guide can send updates" }, "JWTMercureSubscriberToken": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The JWT mercure token to publish updates" }, "mercureHubPublicUrl": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The mercure hub url to connect for subscribing and updating" }, "JWTMercurePublisherToken": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The JWT mercure token to subscribe for updates" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The appointment id" }, "newContextToken": { "type": "string", "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, "attendeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The created Id for the attendee" }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "The id of the current sales channel" }, "salesChannelName": { "type": "string", "description": "The name of the current sales channel" }, "appointmentName": { "type": "string", "description": "The name of the appointment" }, "presentationGuideMode": { "type": "string", "enum": ["self", "guided"], "description": "The type of the appointment" }, "isPreview": { "type": "boolean", "description": "To see if it's a preview appointment" }, "attendeeName": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The name of the attendee" }, "videoUserId": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The video user id that attendee could use" }, "b2bFeatures": { "type": "object", "description": "The b2b features that available for the appointment", "properties": { "quoteManagement": { "type": "boolean", "description": "To know if the quote management is enabled for current customer" } } } }, "example": { "mercureSubscriberTopics": [ "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" ], "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", "JWTMercureSubscriberToken": "jwt token for subscribing to updates", "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", "JWTMercurePublisherToken": "jwt token for publishing updates", "attendeeName": "attendee name", "videoUserId": null, "b2bFeatures": { "feature1": false, "feature2": true }, "id": "2d2c358f1ca04098aacf12873c2eed82", "newContextToken": "new context token to call the other routes", "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", "salesChannelName": "Storefront", "appointmentName": "Test Appointment", "presentationGuideMode": "guided", "isPreview": false, "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } }, "LineItemType": { "type": "string", "enum": [ "product", "credit", "custom", "promotion", "discount", "container", "quantity", "dsr-line-item-discount", "dsr-cart-discount" ] }, "DiscountLineItemPayload": { "type": "object", "properties": { "discountType": { "type": "string", "enum": ["percentage", "absolute"] }, "discountValue": { "type": "number", "format": "float", "maximum": 0 }, "discountPrice": { "type": "number", "format": "float", "maximum": 0 } } }, "LineItem": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } }, "cover": { "$ref": "#/components/schemas/ProductMedia" }, "dataContextHash": { "type": "string" }, "dataTimestamp": { "type": "string" }, "deliveryInformation": { "$ref": "#/components/schemas/CartDeliveryInformation" }, "description": { "type": "string" }, "good": { "type": "boolean" }, "id": { "type": "string" }, "label": { "type": "string" }, "modified": { "type": "boolean" }, "modifiedByApp": { "type": "boolean" }, "payload": { "allOf": [ { "$ref": "#/components/schemas/ProductJsonApi" }, { "type": "object", "properties": { "discountType": { "type": "string", "enum": ["percentage", "absolute"] }, "discountValue": { "type": "number", "format": "float", "maximum": 0 }, "discountPrice": { "type": "number", "format": "float", "maximum": 0 } } } ] }, "extensions": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "attendees": { "type": "array", "items": { "type": "object", "required": ["id", "name"], "properties": { "name": { "type": "string" }, "id": { "type": "string" } } } } } } } }, "price": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["calculated_price"] }, "calculatedTaxes": { "type": "array", "items": { "type": "object", "properties": { "apiAlias": { "type": "string", "enum": ["cart_tax_calculated"] }, "tax": { "type": "number" }, "taxRate": { "type": "number" }, "price": { "type": "number" } }, "required": ["apiAlias", "tax", "taxRate", "price"] } }, "listPrice": { "oneOf": [ { "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } ] }, "quantity": { "type": "number" }, "referencePrice": { "oneOf": [ { "$ref": "#/components/schemas/CartPriceReference" }, { "type": "null" } ] }, "regulationPrice": { "type": "object", "properties": { "price": { "type": "number" }, "apiAlias": { "type": "string", "enum": ["cart_regulation_price"] } }, "nullable": true }, "totalPrice": { "type": "number" }, "unitPrice": { "type": "number" }, "taxRules": { "type": "array", "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { "taxRate": { "type": "number", "format": "float" }, "name": { "type": "string" } } } } }, "required": ["apiAlias", "totalPrice", "quantity", "unitPrice"] }, "priceDefinition": { "$ref": "#/components/schemas/CartPriceQuantity" }, "quantity": { "type": "number" }, "quantityInformation": { "type": "object", "properties": { "maxPurchase": { "type": "number" }, "minPurchase": { "type": "number" }, "purchaseSteps": { "type": "number" } } }, "referencedId": { "type": "string" }, "removable": { "type": "boolean" }, "stackable": { "type": "boolean" }, "states": { "type": "array", "items": { "type": "string", "enum": ["is-physical", "is-download"] } }, "type": { "$ref": "#/components/schemas/LineItemType" }, "uniqueIdentifier": { "type": "string" } }, "required": ["id", "type"] }, "PresentationCmsPage": { "allOf": [ { "$ref": "#/components/schemas/DsrPresentationCmsPage" }, { "type": "object", "properties": { "pickedProductIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Product id" } }, { "type": "null" } ], "description": "The product id is assigned to presentation if it's product listing or instant listing" } } } ] }, "BasePresentationSlideData": { "properties": { "cmsPage": { "$ref": "#/components/schemas/CmsPage" }, "extensions": { "type": "object", "properties": { "cmsPageRelation": { "$ref": "#/components/schemas/PresentationCmsPage" } } } } }, "PresentationSlideData": { "type": "object", "properties": { "cmsPage": { "$ref": "#/components/schemas/CmsPage" }, "extensions": { "type": "object", "properties": { "cmsPageRelation": { "$ref": "#/components/schemas/PresentationCmsPage" } } }, "product": { "$ref": "#/components/schemas/Product" }, "category": { "$ref": "#/components/schemas/Category" }, "configurator": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroup" } } }, "example": { "extensions": { "cmsPageRelation": { "translated": { "title": null }, "createdAt": "2023-08-09T11:00:13.160+00:00", "updatedAt": null, "presentationId": "506cce706e914c1e8b083f05670d85c4", "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", "title": null, "productId": null, "productStreamId": null, "position": 2, "isInstantListing": false, "cmsPage": { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": { "name": "Default Digital Sales Rooms product listing page", "customFields": [] }, "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "name": "Default Digital Sales Rooms product listing page", "type": "presentation_product_list", "entity": null, "sections": [ { "translated": [], "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "default", "blocks": [ { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": [], "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "product-listing", "slots": [ { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": { "config": { "filters": { "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", "source": "static" }, "boxLayout": { "value": "standard", "source": "static" }, "showSorting": { "value": true, "source": "static" }, "defaultSorting": { "value": "", "source": "static" }, "useCustomSorting": { "value": false, "source": "static" }, "availableSortings": { "value": [], "source": "static" }, "propertyWhitelist": { "value": [], "source": "static" } }, "customFields": [] }, "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "product-listing", "slot": "content", "block": null, "blockId": "96ea8b9676a5461c9149d205d792ecf2", "config": { "filters": { "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", "source": "static" }, "boxLayout": { "value": "standard", "source": "static" }, "showSorting": { "value": true, "source": "static" }, "defaultSorting": { "value": "", "source": "static" }, "useCustomSorting": { "value": false, "source": "static" }, "availableSortings": { "value": [], "source": "static" }, "propertyWhitelist": { "value": [], "source": "static" } }, "fieldConfig": null, "translations": null, "data": null, "locked": false, "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "customFields": null, "apiAlias": "cms_slot" } ], "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", "position": 0, "name": null, "sectionPosition": "main", "marginTop": "20px", "marginBottom": "20px", "marginLeft": "20px", "marginRight": "20px", "backgroundColor": null, "backgroundMediaId": null, "backgroundMedia": null, "backgroundMediaMode": "cover", "cssClass": null, "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "visibility": null, "customFields": null, "apiAlias": "cms_block" } ], "pageId": "33e88c7994fa4cf79a1265e5105b93b2", "page": null, "position": 0, "sizingMode": "boxed", "mobileBehavior": "wrap", "backgroundColor": null, "backgroundMediaId": null, "backgroundMedia": null, "backgroundMediaMode": "cover", "cssClass": null, "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "visibility": null, "customFields": null, "apiAlias": "cms_section" } ], "translations": null, "cssClass": null, "config": null, "previewMediaId": null, "previewMedia": null, "landingPages": null, "id": "33e88c7994fa4cf79a1265e5105b93b2", "customFields": null, "apiAlias": "cms_page" }, "pickedProductIds": null, "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", "id": "4ee08e142ed046eb99681594f67599f1", "customFields": null, "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "apiAlias": "dsr_presentation_cms_page" } }, "cmsPage": { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": { "name": "Default Digital Sales Rooms product listing page", "customFields": [] }, "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "name": "Default Digital Sales Rooms product listing page", "type": "presentation_product_list", "entity": null, "sections": [ { "translated": [], "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "default", "blocks": [ { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": [], "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "product-listing", "slots": [ { "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "translated": { "config": { "filters": { "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", "source": "static" }, "boxLayout": { "value": "standard", "source": "static" }, "showSorting": { "value": true, "source": "static" }, "defaultSorting": { "value": "", "source": "static" }, "useCustomSorting": { "value": false, "source": "static" }, "availableSortings": { "value": [], "source": "static" }, "propertyWhitelist": { "value": [], "source": "static" } }, "customFields": [] }, "createdAt": "2023-08-03T17:24:09.000+00:00", "updatedAt": null, "type": "product-listing", "slot": "content", "block": null, "blockId": "96ea8b9676a5461c9149d205d792ecf2", "config": { "filters": { "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", "source": "static" }, "boxLayout": { "value": "standard", "source": "static" }, "showSorting": { "value": true, "source": "static" }, "defaultSorting": { "value": "", "source": "static" }, "useCustomSorting": { "value": false, "source": "static" }, "availableSortings": { "value": [], "source": "static" }, "propertyWhitelist": { "value": [], "source": "static" } }, "fieldConfig": null, "translations": null, "data": { "listing": { "elements": [ { "versionId": null, "translated": [], "createdAt": null, "updatedAt": null, "parentId": null, "childCount": null, "taxId": null, "manufacturerId": null, "unitId": null, "active": null, "displayGroup": null, "manufacturerNumber": null, "ean": null, "sales": null, "productNumber": null, "stock": null, "availableStock": null, "available": null, "deliveryTimeId": null, "deliveryTime": null, "restockTime": null, "isCloseout": null, "purchaseSteps": null, "maxPurchase": null, "minPurchase": null, "purchaseUnit": null, "referenceUnit": null, "shippingFree": null, "markAsTopseller": null, "weight": null, "width": null, "height": null, "length": null, "releaseDate": null, "categoryTree": null, "streamIds": null, "optionIds": null, "propertyIds": null, "name": null, "keywords": null, "description": null, "metaDescription": null, "metaTitle": null, "packUnit": null, "packUnitPlural": null, "tax": null, "manufacturer": null, "unit": null, "cover": null, "parent": null, "children": null, "media": null, "cmsPageId": null, "cmsPage": null, "translations": null, "categories": null, "properties": null, "options": null, "configuratorSettings": null, "categoriesRo": null, "coverId": null, "categoryIds": null, "productReviews": null, "ratingAverage": null, "mainCategories": null, "seoUrls": null, "crossSellings": null, "canonicalProductId": null, "canonicalProduct": null, "streams": null, "downloads": null, "states": [], "id": "a32702bb0b1443e3881c3b9a38c09169", "customFields": null, "apiAlias": "product" } ], "aggregations": [], "page": 1, "limit": null, "entity": "product", "total": 0, "states": [], "apiAlias": "dal_entity_search_result" }, "apiAlias": "cms_product_listing" }, "locked": false, "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "customFields": null, "apiAlias": "cms_slot" } ], "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", "position": 0, "name": null, "sectionPosition": "main", "marginTop": "20px", "marginBottom": "20px", "marginLeft": "20px", "marginRight": "20px", "backgroundColor": null, "backgroundMediaId": null, "backgroundMedia": null, "backgroundMediaMode": "cover", "cssClass": null, "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "visibility": null, "customFields": null, "apiAlias": "cms_block" } ], "pageId": "33e88c7994fa4cf79a1265e5105b93b2", "page": null, "position": 0, "sizingMode": "boxed", "mobileBehavior": "wrap", "backgroundColor": null, "backgroundMediaId": null, "backgroundMedia": null, "backgroundMediaMode": "cover", "cssClass": null, "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", "visibility": null, "customFields": null, "apiAlias": "cms_section" } ], "translations": null, "cssClass": null, "config": null, "previewMediaId": null, "previewMedia": null, "landingPages": null, "id": "33e88c7994fa4cf79a1265e5105b93b2", "customFields": null, "apiAlias": "cms_page" }, "category": { "versionId": null, "translated": { "breadcrumb": [] }, "createdAt": null, "updatedAt": null, "afterCategoryId": null, "parentId": null, "mediaId": null, "name": null, "breadcrumb": [], "path": null, "level": null, "active": null, "childCount": null, "visibleChildCount": 0, "displayNestedProducts": null, "parent": null, "children": null, "translations": null, "media": null, "cmsPageId": null, "cmsPageIdSwitched": false, "cmsPage": null, "linkType": null, "linkNewTab": null, "internalLink": null, "externalLink": null, "visible": null, "type": null, "productAssignmentType": null, "description": null, "metaTitle": null, "metaDescription": null, "keywords": null, "seoUrls": null, "customEntityTypeId": null, "id": "34f21c5eb6d54a939f10973204aa5f08", "customFields": null, "apiAlias": "category" }, "apiAlias": "pwa_page_result" } }, "StateForAll": { "type": "object", "properties": { "currentGuideProductId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "lastActiveGuideSection": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "currentPageId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "currentSectionId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "currentSlideAlias": { "type": "integer", "default": 0 }, "currentSlideData": { "anyOf": [ { "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" }, { "type": "null" } ] }, "currentDynamicPage": { "$ref": "#/components/schemas/DynamicPageOpenedPayload" }, "started": { "type": "boolean", "default": false }, "running": { "type": "boolean", "default": false }, "ended": { "type": "boolean", "default": false }, "startedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "endedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "accessibleFrom": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "accessibleTo": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "appointmentMode": { "type": "string", "enum": ["guided", "self"] }, "videoAudioSettings": { "type": "string", "enum": ["both", "none", "audio-only"], "default": "none" }, "videoRoomUrl": { "type": "string", "default": "" }, "attendeeRestrictionType": { "anyOf": [ { "type": "string", "enum": ["open", "customer", "rules"] }, { "type": "null" } ] }, "productDetailDefaultPageId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "quickviewPageId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "productListingDefaultPageId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ] }, "broadcastMode": { "type": "boolean", "default": false }, "viewMode": { "type": "string", "enum": ["onlyYou", "presentation", "videoGrid"], "default": "presentation" }, "allowScreenSharing": { "type": "boolean", "default": false }, "extensions": { "type": "array", "default": [] } } }, "StateForGuides": { "type": "object", "properties": { "clients": { "type": "array", "items": { "type": "string" }, "default": [] }, "inactiveClients": { "type": "array", "items": { "type": "string" }, "default": [] }, "guides": { "type": "array", "items": { "type": "string" }, "default": [] }, "videoGuideToken": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "quickViewState": { "type": "array", "items": { "type": "string" }, "default": [] }, "extensions": { "type": "array", "default": [] } } }, "VideoChatCreateStruct": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", "properties": { "roomUrl": { "type": "string", "description": "Url of the video room in daily" }, "roomName": { "type": "string", "description": "Name of the video room in daily" }, "userToken": { "type": "string", "description": "Token for the end users to connect to the daily room" }, "ownerToken": { "type": "string", "description": "Token for the room owner (guide) to connect to the daily room" } }, "example": { "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", "userToken": "dummy user token", "ownerToken": "dummy owner token", "roomName": "rSq20mrgwsj4eIXo1u95", "extensions": [] } }, "WidgetProductListing": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", "properties": { "extensions": { "type": "array", "description": "List of extensions", "default": [] }, "products": { "type": "array", "description": "List of last seen products", "items": { "allOf": [ { "$ref": "#/components/schemas/Product" }, { "type": "object", "properties": { "customFields": { "type": "object", "properties": { "wishlistAttendeeIds": { "type": "array", "items": { "type": "string" } } } } } } ] } }, "total": { "type": "integer", "description": "The total number of products" }, "page": { "type": "integer", "description": "The current page" }, "limit": { "type": "integer", "description": "The number of products per page" } } }, "swag_paypal_pos_webhook": { "required": [ "organizationUuid", "messageUuid", "eventName", "payload", "timestamp" ], "properties": { "organizationUuid": { "type": "string" }, "messageUuid": { "type": "string" }, "eventName": { "type": "string" }, "payload": { "type": "string" }, "timestamp": { "type": "string" } }, "type": "object" }, "swag_paypal_pos_setting_additional_information": { "required": [ "extensions", "countryId", "currencyId", "languageId", "customerGroupId", "navigationCategoryId", "shippingMethodId", "paymentMethodId", "merchantInformation" ], "properties": { "extensions": { "type": "object", "additionalProperties": true }, "countryId": { "type": "string" }, "currencyId": { "type": "string" }, "languageId": { "type": "string", "nullable": true }, "customerGroupId": { "type": "string" }, "navigationCategoryId": { "type": "string" }, "shippingMethodId": { "type": "string" }, "paymentMethodId": { "type": "string" }, "merchantInformation": { "type": "array", "items": { "type": "mixed" } } }, "type": "object" }, "swag_paypal_pos_setting_product_count": { "required": ["localCount", "remoteCount"], "properties": { "localCount": { "type": "integer" }, "remoteCount": { "type": "integer" } }, "type": "object" }, "swag_paypal_setting_merchant_information": { "required": ["merchantIntegrations", "capabilities"], "properties": { "merchantIntegrations": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_merchant_integrations" } ], "nullable": true }, "capabilities": { "description": "string> key: paymentMethodId, value: capability (see AbstractMethodData)", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "swag_paypal_setting_settings_information": { "required": [ "sandboxCredentialsChanged", "sandboxCredentialsValid", "liveCredentialsChanged", "liveCredentialsValid", "webhookErrors" ], "properties": { "sandboxCredentialsChanged": { "type": "boolean" }, "sandboxCredentialsValid": { "type": "boolean", "nullable": true }, "liveCredentialsChanged": { "type": "boolean" }, "liveCredentialsValid": { "type": "boolean", "nullable": true }, "webhookErrors": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_error_detail": { "required": ["field", "value", "location", "issue", "description"], "properties": { "field": { "type": "string" }, "value": { "type": "string" }, "location": { "type": "string" }, "issue": { "type": "string" }, "description": { "type": "string" } }, "type": "object" }, "paypal_error": { "required": [ "name", "message", "debug_id", "details", "links", "error", "error_description" ], "properties": { "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "debug_id": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_error_detail" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" }, "nullable": true }, "error": { "description": "Only set if OAuth error occurs", "type": "string", "nullable": true }, "error_description": { "description": "Only set if OAuth error occurs", "type": "string", "nullable": true } }, "type": "object" }, "paypal_v1_capture": { "required": [ "amount", "is_final_capture", "id", "state", "reason_code", "parent_payment", "transaction_fee", "create_time", "update_time", "links" ], "properties": { "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "is_final_capture": { "type": "boolean" }, "id": { "type": "string" }, "state": { "type": "string" }, "reason_code": { "type": "string" }, "parent_payment": { "type": "string" }, "transaction_fee": { "$ref": "#/components/schemas/paypal_v1_capture_transaction_fee" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_capture_transaction_fee": { "allOf": [{ "$ref": "#/components/schemas/paypal_v1_common_value" }] }, "paypal_v1_client_token": { "required": ["client_token", "expires_in", "expire_date_time"], "properties": { "client_token": { "type": "string" }, "expires_in": { "description": "The lifetime of the access token, in seconds.", "type": "integer" }, "expire_date_time": { "description": "Calculated expiration date", "type": "string", "format": "date-time" } }, "type": "object" }, "paypal_v1_common_address": { "required": [ "line_1", "line_2", "city", "country_code", "postal_code", "state", "phone" ], "properties": { "line_1": { "type": "string" }, "line_2": { "type": "string", "nullable": true }, "city": { "type": "string" }, "country_code": { "type": "string" }, "postal_code": { "type": "string" }, "state": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "type": "object" }, "paypal_v1_common_amount": { "required": ["total", "currency", "details"], "properties": { "total": { "type": "string" }, "currency": { "type": "string" }, "details": { "$ref": "#/components/schemas/paypal_v1_common_details" } }, "type": "object" }, "paypal_v1_common_details": { "required": [ "subtotal", "shipping", "tax", "handling_fee", "shipping_discount", "discount", "insurance" ], "properties": { "subtotal": { "type": "string" }, "shipping": { "type": "string" }, "tax": { "type": "string" }, "handling_fee": { "type": "string" }, "shipping_discount": { "type": "string" }, "discount": { "type": "string" }, "insurance": { "type": "string" } }, "type": "object" }, "paypal_v1_common_link": { "required": ["href", "rel", "method", "enc_type"], "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "method": { "type": "string" }, "enc_type": { "type": "string", "nullable": true } }, "type": "object" }, "paypal_v1_common_money": { "required": ["value", "currency_code"], "properties": { "value": { "type": "string" }, "currency_code": { "type": "string" } }, "type": "object" }, "paypal_v1_common_value": { "required": ["currency", "value"], "properties": { "currency": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes": { "required": ["items", "links"], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_disputes_common_buyer": { "required": ["name"], "properties": { "name": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_common_item": { "required": [ "item_id", "item_description", "item_quantity", "partner_transaction_id", "reason", "dispute_amount", "notes" ], "properties": { "item_id": { "type": "string" }, "item_description": { "type": "string" }, "item_quantity": { "type": "string" }, "partner_transaction_id": { "type": "string" }, "reason": { "type": "string" }, "dispute_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "notes": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_common_product_details": { "required": [ "product_received", "product_received_time", "sub_reasons", "purchase_url", "return_details" ], "properties": { "product_received": { "type": "string" }, "product_received_time": { "type": "string" }, "sub_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_common_sub_reason" } }, "purchase_url": { "type": "string" }, "return_details": { "$ref": "#/components/schemas/paypal_v1_disputes_common_return_details" } }, "type": "object" }, "paypal_v1_disputes_common_return_details": { "required": [ "return_time", "mode", "receipt", "return_confirmation_number", "returned" ], "properties": { "return_time": { "type": "string" }, "mode": { "type": "string" }, "receipt": { "type": "boolean" }, "return_confirmation_number": { "type": "string" }, "returned": { "type": "boolean" } }, "type": "object" }, "paypal_v1_disputes_common_seller": { "required": ["email", "merchant_id", "name"], "properties": { "email": { "type": "string" }, "merchant_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_common_service_details": { "required": [ "description", "service_started", "note", "sub_reasons", "purchase_url" ], "properties": { "description": { "type": "string" }, "service_started": { "type": "string" }, "note": { "type": "string" }, "sub_reasons": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_common_sub_reason" } }, "purchase_url": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_common_sub_reason": { "required": ["sub_reason"], "properties": { "sub_reason": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_common_transaction": { "required": [ "buyer_transaction_id", "seller_transaction_id", "reference_id", "create_time", "transaction_status", "gross_amount", "invoice_number", "custom", "buyer", "seller", "items" ], "properties": { "buyer_transaction_id": { "type": "string" }, "seller_transaction_id": { "type": "string" }, "reference_id": { "type": "string" }, "create_time": { "type": "string" }, "transaction_status": { "type": "string" }, "gross_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "invoice_number": { "type": "string" }, "custom": { "type": "string" }, "buyer": { "$ref": "#/components/schemas/paypal_v1_disputes_common_buyer" }, "seller": { "$ref": "#/components/schemas/paypal_v1_disputes_common_seller" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_common_item" } } }, "type": "object" }, "paypal_v1_disputes_item": { "required": [ "dispute_id", "create_time", "update_time", "disputed_transactions", "reason", "status", "dispute_state", "dispute_amount", "external_reason_code", "dispute_outcome", "adjudications", "money_movements", "dispute_life_cycle_stage", "dispute_channel", "messages", "extensions", "evidences", "buyer_response_due_date", "seller_response_due_date", "offer", "refund_details", "communication_details", "partner_actions", "supporting_info", "links" ], "properties": { "dispute_id": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "disputed_transactions": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_disputed_transaction" }, "nullable": true }, "reason": { "type": "string" }, "status": { "type": "string" }, "dispute_state": { "type": "string", "enum": [ "REQUIRED_ACTION", "REQUIRED_OTHER_PARTY_ACTION", "UNDER_PAYPAL_REVIEW", "RESOLVED", "OPEN_INQUIRIES", "APPEALABLE" ], "nullable": true }, "dispute_amount": { "$ref": "#/components/schemas/paypal_v1_disputes_item_dispute_amount" }, "external_reason_code": { "type": "string", "nullable": true }, "dispute_outcome": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_disputes_item_dispute_outcome" } ], "nullable": true }, "adjudications": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_adjudication" } }, "money_movements": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_money_movement" } }, "dispute_life_cycle_stage": { "type": "string" }, "dispute_channel": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_message" }, "nullable": true }, "extensions": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions" }, "evidences": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_evidence" }, "nullable": true }, "buyer_response_due_date": { "type": "string", "nullable": true }, "seller_response_due_date": { "type": "string", "nullable": true }, "offer": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_disputes_item_offer" } ], "nullable": true }, "refund_details": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_disputes_item_refund_details" } ], "nullable": true }, "communication_details": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_disputes_item_communication_details" } ], "nullable": true }, "partner_actions": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_partner_action" }, "nullable": true }, "supporting_info": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_supporting_info" }, "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_disputes_item_adjudication": { "required": [ "type", "adjudication_time", "reason", "dispute_life_cycle_stage" ], "properties": { "type": { "type": "string" }, "adjudication_time": { "type": "string" }, "reason": { "type": "string" }, "dispute_life_cycle_stage": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_communication_details": { "required": ["email", "note", "time_posted"], "properties": { "email": { "type": "string" }, "note": { "type": "string" }, "time_posted": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_dispute_amount": { "allOf": [{ "$ref": "#/components/schemas/paypal_v1_common_money" }] }, "paypal_v1_disputes_item_dispute_outcome": { "required": ["outcome_code", "amount_refunded"], "properties": { "outcome_code": { "type": "string" }, "amount_refunded": { "$ref": "#/components/schemas/paypal_v1_common_money" } }, "type": "object" }, "paypal_v1_disputes_item_disputed_transaction": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/paypal_v1_disputes_common_transaction" }, { "required": ["seller_protection_eligible"], "properties": { "seller_protection_eligible": { "type": "boolean" } }, "type": "object" } ] }, "paypal_v1_disputes_item_evidence": { "required": [ "evidence_type", "evidence_info", "documents", "notes", "item_id" ], "properties": { "evidence_type": { "type": "string" }, "evidence_info": { "$ref": "#/components/schemas/paypal_v1_disputes_item_evidence_evidence_info" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_evidence_document" } }, "notes": { "type": "string" }, "item_id": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_evidence_document": { "required": ["name"], "properties": { "name": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_evidence_evidence_info": { "required": ["tracking_info", "refund_ids"], "properties": { "tracking_info": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_evidence_evidence_info_tracking_info" } }, "refund_ids": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_evidence_evidence_info_refund_id" } } }, "type": "object" }, "paypal_v1_disputes_item_evidence_evidence_info_refund_id": { "required": ["refund_id"], "properties": { "refund_id": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_evidence_evidence_info_tracking_info": { "required": [ "carrier_name", "carrier_name_other", "tracking_url", "tracking_number" ], "properties": { "carrier_name": { "type": "string" }, "carrier_name_other": { "type": "string" }, "tracking_url": { "type": "string" }, "tracking_number": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_extensions": { "required": [ "merchant_contacted", "merchant_contacted_outcome", "merchant_contacted_time", "merchant_contacted_mode", "buyer_contacted_time", "buyer_contacted_channel", "billing_dispute_properties", "merchandize_dispute_properties" ], "properties": { "merchant_contacted": { "type": "boolean" }, "merchant_contacted_outcome": { "type": "string" }, "merchant_contacted_time": { "type": "string" }, "merchant_contacted_mode": { "type": "string" }, "buyer_contacted_time": { "type": "string" }, "buyer_contacted_channel": { "type": "string" }, "billing_dispute_properties": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties" }, "merchandize_dispute_properties": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_merchandize_dispute_properties" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties": { "required": [ "duplicate_transaction", "incorrect_transaction_amount", "payment_by_other_means", "credit_not_processed", "canceled_recurring_billing" ], "properties": { "duplicate_transaction": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_duplicate_transaction" }, "incorrect_transaction_amount": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_incorrect_transaction_amount" }, "payment_by_other_means": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_payment_by_other_means" }, "credit_not_processed": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_credit_not_processed" }, "canceled_recurring_billing": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_canceled_recurring_billing" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_canceled_recurring_billing": { "required": ["expected_refund", "cancellation_details"], "properties": { "expected_refund": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "cancellation_details": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_common_agreed_refund_details": { "required": ["merchant_agreed_refund", "merchant_agreed_refund_time"], "properties": { "merchant_agreed_refund": { "type": "boolean" }, "merchant_agreed_refund_time": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details": { "required": [ "cancellation_date", "cancellation_number", "cancelled", "cancellation_mode" ], "properties": { "cancellation_date": { "type": "string" }, "cancellation_number": { "type": "string" }, "cancelled": { "type": "boolean" }, "cancellation_mode": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_credit_not_processed": { "required": [ "issue_type", "expected_refund", "cancellation_details", "product_details", "service_details", "agreed_refund_details" ], "properties": { "issue_type": { "type": "string" }, "expected_refund": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "cancellation_details": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details" }, "product_details": { "$ref": "#/components/schemas/paypal_v1_disputes_common_product_details" }, "service_details": { "$ref": "#/components/schemas/paypal_v1_disputes_common_service_details" }, "agreed_refund_details": { "$ref": "#/components/schemas/paypal_v1_disputes_item_extensions_billing_dispute_properties_common_agreed_refund_details" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_duplicate_transaction": { "required": ["received_duplicate", "original_transaction"], "properties": { "received_duplicate": { "type": "boolean" }, "original_transaction": { "$ref": "#/components/schemas/paypal_v1_disputes_common_transaction" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_incorrect_transaction_amount": { "required": ["correct_transaction_amount", "correct_transaction_time"], "properties": { "correct_transaction_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "correct_transaction_time": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_billing_dispute_properties_payment_by_other_means": { "required": [ "charge_different_from_original", "received_duplicate", "payment_method", "payment_instrument_suffix" ], "properties": { "charge_different_from_original": { "type": "boolean" }, "received_duplicate": { "type": "boolean" }, "payment_method": { "type": "string" }, "payment_instrument_suffix": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_extensions_merchandize_dispute_properties": { "required": ["issue_type", "product_details", "service_details"], "properties": { "issue_type": { "type": "string" }, "product_details": { "$ref": "#/components/schemas/paypal_v1_disputes_common_product_details" }, "service_details": { "$ref": "#/components/schemas/paypal_v1_disputes_common_service_details" } }, "type": "object" }, "paypal_v1_disputes_item_message": { "required": ["posted_by", "time_posted", "content"], "properties": { "posted_by": { "type": "string" }, "time_posted": { "type": "string" }, "content": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_money_movement": { "required": [ "affected_party", "amount", "initiated_time", "type", "reason" ], "properties": { "affected_party": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "initiated_time": { "type": "string" }, "type": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_offer": { "required": [ "buyer_requested_amount", "seller_offered_amount", "offer_type", "history" ], "properties": { "buyer_requested_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "seller_offered_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "offer_type": { "type": "string" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_disputes_item_offer_history" }, "nullable": true } }, "type": "object" }, "paypal_v1_disputes_item_offer_history": { "required": ["offer_time", "actor", "event_type", "offer_type"], "properties": { "offer_time": { "type": "string" }, "actor": { "type": "string" }, "event_type": { "type": "string" }, "offer_type": { "type": "string" } }, "type": "object" }, "paypal_v1_disputes_item_partner_action": { "required": [ "id", "name", "create_time", "update_time", "due_time", "status", "amount" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "due_time": { "type": "string" }, "status": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_money" } }, "type": "object" }, "paypal_v1_disputes_item_refund_details": { "required": ["allowed_refund_amount"], "properties": { "allowed_refund_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" } }, "type": "object" }, "paypal_v1_disputes_item_supporting_info": { "required": ["notes", "source", "provided_time"], "properties": { "notes": { "type": "string" }, "source": { "type": "string" }, "provided_time": { "type": "string" } }, "type": "object" }, "paypal_v1_do_void": { "required": [ "id", "amount", "state", "parent_payment", "create_time", "update_time", "links" ], "properties": { "id": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "state": { "type": "string" }, "parent_payment": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_merchant_integrations": { "required": [ "merchant_id", "tracking_id", "products", "capabilities", "oauth_integrations", "granted_permissions", "payments_receivable", "legal_name", "primary_email", "primary_email_confirmed" ], "properties": { "merchant_id": { "type": "string" }, "tracking_id": { "type": "string" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_merchant_integrations_product" } }, "capabilities": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_merchant_integrations_capability" }, "nullable": true }, "oauth_integrations": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_merchant_integrations_oauth_integration" } }, "granted_permissions": { "type": "array", "items": { "type": "string" } }, "payments_receivable": { "type": "boolean" }, "legal_name": { "type": "string" }, "primary_email": { "type": "string" }, "primary_email_confirmed": { "type": "boolean" } }, "type": "object" }, "paypal_v1_merchant_integrations_capability": { "required": ["name", "status"], "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "paypal_v1_merchant_integrations_credentials": { "required": ["client_id", "client_secret", "payer_id"], "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "payer_id": { "type": "string" } }, "type": "object" }, "paypal_v1_merchant_integrations_oauth_integration": { "required": ["integrationMethod", "integrationType", "oauthThirdParty"], "properties": { "integration_method": { "type": "string" }, "integration_type": { "type": "string" }, "status": { "type": "string" }, "oauth_third_party": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_merchant_integrations_oauth_integration_oauth_third_party" } } }, "type": "object" }, "paypal_v1_merchant_integrations_oauth_integration_oauth_third_party": { "required": ["merchantClientId", "partnerClientId", "scopes"], "properties": { "access_token": { "type": "string" }, "merchant_client_id": { "type": "string" }, "partner_client_id": { "type": "string" }, "refresh_token": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_v1_merchant_integrations_product": { "required": ["name"], "properties": { "name": { "type": "string" }, "vetting_status": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_v1_merchant_tracking": { "required": ["merchant_id", "tracking_id", "links"], "properties": { "merchant_id": { "type": "string" }, "tracking_id": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_patch": { "required": ["op", "path", "value"], "properties": { "op": { "type": "string", "enum": ["add", "replace"] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "mixed" } } ] } }, "type": "object" }, "paypal_v1_payment": { "required": [ "id", "state", "cart", "payer", "transactions", "create_time", "update_time", "links", "redirect_urls", "application_context", "payment_instruction" ], "properties": { "id": { "type": "string" }, "intent": { "type": "string", "default": "sale", "enum": ["sale", "authorize", "order"] }, "state": { "type": "string" }, "cart": { "type": "string" }, "payer": { "$ref": "#/components/schemas/paypal_v1_payment_payer" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_payment_transaction" } }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "redirect_urls": { "$ref": "#/components/schemas/paypal_v1_payment_redirect_urls" }, "application_context": { "$ref": "#/components/schemas/paypal_v1_payment_application_context" }, "payment_instruction": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_payment_instruction" } ], "nullable": true } }, "type": "object" }, "paypal_v1_payment_application_context": { "required": ["brand_name", "locale", "landing_page"], "properties": { "brand_name": { "type": "string" }, "locale": { "type": "string" }, "landing_page": { "type": "string", "enum": ["Login", "Billing"] }, "shipping_preference": { "type": "string", "default": "SET_PROVIDED_ADDRESS" }, "user_action": { "type": "string", "default": "commit" } }, "type": "object" }, "paypal_v1_payment_payer": { "required": [ "payment_method", "status", "payer_info", "external_selected_funding_instrument_type" ], "properties": { "payment_method": { "type": "string" }, "status": { "type": "string" }, "payer_info": { "$ref": "#/components/schemas/paypal_v1_payment_payer_payer_info" }, "external_selected_funding_instrument_type": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_payer_execute_payer_info": { "required": ["payer_id"], "properties": { "payer_id": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_payer_payer_info": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_payer_execute_payer_info" }, { "required": [ "email", "first_name", "last_name", "billing_address", "shipping_address", "phone", "country_code" ], "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "billing_address": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_common_address" } ], "nullable": true }, "shipping_address": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_item_list_shipping_address" }, "phone": { "type": "string" }, "country_code": { "type": "string" } }, "type": "object" } ] }, "paypal_v1_payment_payment_instruction": { "required": [ "reference_number", "recipient_banking_instruction", "amount", "payment_due_date", "instruction_type", "links" ], "properties": { "reference_number": { "type": "string" }, "recipient_banking_instruction": { "$ref": "#/components/schemas/paypal_v1_payment_payment_instruction_recipient_banking_instruction" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "payment_due_date": { "type": "string" }, "instruction_type": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_payment_payment_instruction_recipient_banking_instruction": { "required": [ "bank_name", "account_holder_name", "international_bank_account_number", "bank_identifier_code" ], "properties": { "bank_name": { "type": "string" }, "account_holder_name": { "type": "string" }, "international_bank_account_number": { "type": "string" }, "bank_identifier_code": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_redirect_urls": { "required": ["return_url", "cancel_url"], "properties": { "return_url": { "type": "string" }, "cancel_url": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction": { "required": [ "amount", "payee", "item_list", "related_resources", "invoice_number", "soft_descriptor", "description", "custom" ], "properties": { "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payee": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_payee" }, "item_list": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_item_list" } ], "nullable": true }, "related_resources": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource" } }, "invoice_number": { "type": "string", "nullable": true }, "soft_descriptor": { "type": "string" }, "description": { "type": "string" }, "custom": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_item_list": { "required": [ "shipping_address", "items", "shipping_options", "shipping_phone_number" ], "properties": { "shipping_address": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_item_list_shipping_address" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_item_list_item" } }, "shipping_options": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_payment_transaction_item_list_shipping_option" } }, "shipping_phone_number": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_item_list_item": { "required": ["name", "currency", "price", "quantity", "sku", "tax"], "properties": { "name": { "type": "string", "maxLength": 127 }, "currency": { "type": "string" }, "price": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string", "maxLength": 127, "nullable": true }, "tax": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_item_list_shipping_address": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/paypal_v1_common_address" }, { "required": ["recipient_name"], "properties": { "recipient_name": { "type": "string" } }, "type": "object" } ] }, "paypal_v1_payment_transaction_item_list_shipping_option": { "properties": [] }, "paypal_v1_payment_transaction_payee": { "required": ["merchant_id", "email"], "properties": { "merchant_id": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource": { "required": ["sale", "authorization", "order", "refund", "capture"], "properties": { "sale": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_sale" } ], "nullable": true }, "authorization": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_authorization" } ], "nullable": true }, "order": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_order" } ], "nullable": true }, "refund": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_refund" } ], "nullable": true }, "capture": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_payment_transaction_related_resource_capture" } ], "nullable": true } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource_authorization": { "required": [ "id", "state", "amount", "payment_mode", "create_time", "update_time", "protection_eligibility", "protection_eligibility_type", "receipt_id", "parent_payment", "links", "reason_code", "valid_until" ], "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "protection_eligibility": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "receipt_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "reason_code": { "type": "string" }, "valid_until": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource_capture": { "required": [ "id", "state", "amount", "payment_mode", "create_time", "update_time", "protection_eligibility", "protection_eligibility_type", "receipt_id", "parent_payment", "links", "custom", "transaction_fee", "invoice_number" ], "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "protection_eligibility": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "receipt_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "custom": { "type": "string" }, "transaction_fee": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "invoice_number": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource_order": { "required": [ "id", "state", "amount", "payment_mode", "create_time", "update_time", "protection_eligibility", "protection_eligibility_type", "receipt_id", "parent_payment", "links", "reason_code" ], "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "protection_eligibility": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "receipt_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "reason_code": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource_refund": { "required": [ "id", "state", "amount", "payment_mode", "create_time", "update_time", "protection_eligibility", "protection_eligibility_type", "receipt_id", "parent_payment", "links", "sale_id", "capture_id" ], "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "protection_eligibility": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "receipt_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "sale_id": { "type": "string" }, "capture_id": { "type": "string" } }, "type": "object" }, "paypal_v1_payment_transaction_related_resource_sale": { "required": [ "id", "state", "amount", "payment_mode", "create_time", "update_time", "protection_eligibility", "protection_eligibility_type", "receipt_id", "parent_payment", "links", "transaction_fee" ], "properties": { "id": { "type": "string" }, "state": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "protection_eligibility": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "receipt_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "transaction_fee": { "$ref": "#/components/schemas/paypal_v1_common_value" } }, "type": "object" }, "paypal_v1_plan": { "required": [ "product_id", "name", "description", "status", "billing_cycles", "payment_preferences", "taxes" ], "properties": { "product_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "billing_cycles": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_plan_billing_cycle" } }, "payment_preferences": { "$ref": "#/components/schemas/paypal_v1_plan_payment_preferences" }, "taxes": { "$ref": "#/components/schemas/paypal_v1_plan_taxes" } }, "type": "object" }, "paypal_v1_plan_billing_cycle": { "required": [ "frequency", "tenure_type", "sequence", "pricing_scheme", "total_cycles" ], "properties": { "frequency": { "$ref": "#/components/schemas/paypal_v1_plan_billing_cycle_frequency" }, "tenure_type": { "type": "string" }, "sequence": { "type": "integer" }, "pricing_scheme": { "$ref": "#/components/schemas/paypal_v1_plan_billing_cycle_pricing_scheme" }, "total_cycles": { "type": "integer" } }, "type": "object" }, "paypal_v1_plan_billing_cycle_frequency": { "required": ["interval_unit", "interval_count"], "properties": { "interval_unit": { "type": "string" }, "interval_count": { "type": "integer" } }, "type": "object" }, "paypal_v1_plan_billing_cycle_pricing_scheme": { "required": ["fixed_price"], "properties": { "fixed_price": { "$ref": "#/components/schemas/paypal_v1_common_money" } }, "type": "object" }, "paypal_v1_plan_payment_preferences": { "required": ["auto_bill_outstanding", "payment_failure_threshold"], "properties": { "auto_bill_outstanding": { "type": "boolean" }, "payment_failure_threshold": { "type": "integer" } }, "type": "object" }, "paypal_v1_plan_taxes": { "required": ["percentage", "inclusive"], "properties": { "percentage": { "type": "string" }, "inclusive": { "type": "boolean" } }, "type": "object" }, "paypal_v1_product": { "required": ["name", "description", "type"], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "paypal_v1_refund": { "required": [ "amount", "invoice_number", "description", "reason", "id", "create_time", "update_time", "state", "refund_from_transaction_fee", "total_refunded_amount", "refund_from_received_amount", "sale_id", "capture_id", "parent_payment", "links" ], "properties": { "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "invoice_number": { "type": "string" }, "description": { "type": "string" }, "reason": { "type": "string" }, "id": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "state": { "type": "string" }, "refund_from_transaction_fee": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "total_refunded_amount": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "refund_from_received_amount": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "sale_id": { "type": "string" }, "capture_id": { "type": "string" }, "parent_payment": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_shipping": { "required": ["trackers"], "properties": { "trackers": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_shipping_tracker" } } }, "type": "object" }, "paypal_v1_shipping_tracker": { "required": [ "transaction_id", "tracking_number", "status", "carrier", "notify_buyer", "shipment_date" ], "properties": { "transaction_id": { "type": "string" }, "tracking_number": { "type": "string" }, "status": { "type": "string" }, "carrier": { "type": "string" }, "notify_buyer": { "type": "boolean" }, "shipment_date": { "type": "string", "format": "date-time" } }, "type": "object" }, "paypal_v1_subscription": { "required": [ "id", "plan_id", "start_time", "quantity", "shipping_amount", "subscriber", "billing_info", "application_context", "status", "status_update_time", "create_time", "update_time", "links" ], "properties": { "id": { "type": "string" }, "plan_id": { "type": "string" }, "start_time": { "type": "string" }, "quantity": { "type": "string" }, "shipping_amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "subscriber": { "$ref": "#/components/schemas/paypal_v1_subscription_subscriber" }, "billing_info": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_subscription_billing_info" } ], "nullable": true }, "application_context": { "$ref": "#/components/schemas/paypal_v1_subscription_application_context" }, "status": { "type": "string" }, "status_update_time": { "type": "string" }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_subscription_application_context": { "required": ["brand_name", "locale", "return_url", "cancel_url"], "properties": { "user_action": { "type": "string", "default": "SUBSCRIBE_NOW" }, "brand_name": { "type": "string" }, "locale": { "type": "string" }, "shipping_preference": { "type": "string", "default": "SET_PROVIDED_ADDRESS" }, "return_url": { "type": "string" }, "cancel_url": { "type": "string" } }, "type": "object" }, "paypal_v1_subscription_billing_info": { "required": [ "outstanding_balance", "cycle_executions", "last_payment", "next_billing_time", "failed_payments_count" ], "properties": { "outstanding_balance": { "$ref": "#/components/schemas/paypal_v1_subscription_billing_info_outstanding_balance" }, "cycle_executions": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_subscription_billing_info_cycle_execution" } }, "last_payment": { "$ref": "#/components/schemas/paypal_v1_subscription_billing_info_last_payment" }, "next_billing_time": { "type": "string", "nullable": true }, "failed_payments_count": { "type": "integer" } }, "type": "object" }, "paypal_v1_subscription_billing_info_cycle_execution": { "required": [ "tenure_type", "sequence", "cycles_completed", "cycles_remaining", "total_cycles" ], "properties": { "tenure_type": { "type": "string" }, "sequence": { "type": "integer" }, "cycles_completed": { "type": "integer" }, "cycles_remaining": { "type": "integer" }, "total_cycles": { "type": "integer" } }, "type": "object" }, "paypal_v1_subscription_billing_info_last_payment": { "required": ["amount", "time"], "properties": { "amount": { "$ref": "#/components/schemas/paypal_v1_common_money" }, "time": { "type": "string" } }, "type": "object" }, "paypal_v1_subscription_billing_info_outstanding_balance": { "allOf": [{ "$ref": "#/components/schemas/paypal_v1_common_money" }] }, "paypal_v1_subscription_subscriber": { "required": ["name", "email_address", "payer_id", "shipping_address"], "properties": { "name": { "$ref": "#/components/schemas/paypal_v1_subscription_subscriber_name" }, "email_address": { "type": "string" }, "payer_id": { "type": "string" }, "shipping_address": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_subscription_subscriber_shipping_address" } ], "nullable": true } }, "type": "object" }, "paypal_v1_subscription_subscriber_name": { "required": ["given_name", "surname"], "properties": { "given_name": { "type": "string" }, "surname": { "type": "string" } }, "type": "object" }, "paypal_v1_subscription_subscriber_shipping_address": { "required": ["name", "address"], "properties": { "name": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_subscription_subscriber_shipping_address_name" } ], "nullable": true }, "address": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v1_subscription_subscriber_shipping_address_address" } ], "nullable": true } }, "type": "object" }, "paypal_v1_subscription_subscriber_shipping_address_address": { "required": [ "address_line_1", "address_line_2", "admin_area_1", "admin_area_2", "postal_code", "country_code" ], "properties": { "address_line_1": { "type": "string", "nullable": true }, "address_line_2": { "type": "string", "nullable": true }, "admin_area_1": { "type": "string", "nullable": true }, "admin_area_2": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "country_code": { "type": "string" } }, "type": "object" }, "paypal_v1_subscription_subscriber_shipping_address_name": { "required": ["full_name"], "properties": { "full_name": { "type": "string" } }, "type": "object" }, "paypal_v1_token": { "required": [ "scope", "nonce", "access_token", "token_type", "app_id", "id_token", "expires_in", "expire_date_time" ], "properties": { "scope": { "description": "Scopes expressed in the form of resource URL endpoints. The value of the scope parameter\nis expressed as a list of space-delimited, case-sensitive strings.", "type": "string" }, "nonce": { "type": "string" }, "access_token": { "description": "The access token issued by PayPal. After the access token\nexpires (see $expiresIn), you must request a new access token.", "type": "string" }, "token_type": { "description": "The type of the token issued as described in OAuth2.0 RFC6749,\nSection 7.1. Value is case insensitive.", "type": "string" }, "app_id": { "type": "string" }, "id_token": { "type": "string", "nullable": true }, "expires_in": { "description": "The lifetime of the access token, in seconds.", "type": "integer" }, "expire_date_time": { "description": "Calculated expiration date", "type": "string", "format": "date-time" } }, "type": "object" }, "paypal_v1_webhook": { "required": ["id", "url", "event_types", "links"], "properties": { "id": { "type": "string" }, "url": { "type": "string", "maxLength": 2048 }, "event_types": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_webhook_event_type" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } } }, "type": "object" }, "paypal_v1_webhook_event": { "required": [ "id", "resource_type", "event_type", "summary", "resource", "create_time", "links", "event_version", "resource_version" ], "properties": { "id": { "type": "string" }, "resource_type": { "type": "string" }, "event_type": { "type": "string" }, "summary": { "type": "string" }, "resource": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/paypal_v3_payment_token" }, { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_authorization" }, { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture" }, { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_refund" }, { "$ref": "#/components/schemas/paypal_v1_webhook_resource" }, { "$ref": "#/components/schemas/paypal_v1_subscription" } ] }, "create_time": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "event_version": { "type": "string" }, "resource_version": { "type": "string" } }, "type": "object" }, "paypal_v1_webhook_event_type": { "required": ["name", "description", "status", "resource_version"], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "resource_version": { "type": "string" } }, "type": "object" }, "paypal_v1_webhook_resource": { "required": [ "id", "parent_payment", "billing_agreement_id", "sale_id", "refund_reason_code", "update_time", "amount", "payment_mode", "create_time", "clearing_time", "protection_eligibility_type", "protection_eligibility", "transaction_fee", "invoice_number", "links", "state", "merchant_id" ], "properties": { "id": { "type": "string" }, "parent_payment": { "type": "string", "nullable": true }, "billing_agreement_id": { "type": "string", "nullable": true }, "sale_id": { "type": "string", "nullable": true }, "refund_reason_code": { "type": "string", "nullable": true }, "update_time": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v1_common_amount" }, "payment_mode": { "type": "string" }, "create_time": { "type": "string" }, "clearing_time": { "type": "string" }, "protection_eligibility_type": { "type": "string" }, "protection_eligibility": { "type": "string" }, "transaction_fee": { "$ref": "#/components/schemas/paypal_v1_common_value" }, "invoice_number": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_common_link" } }, "state": { "type": "string" }, "merchant_id": { "type": "string", "nullable": true } }, "type": "object" }, "paypal_v1_webhook_list": { "required": ["webhooks"], "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v1_webhook" } } }, "type": "object" }, "paypal_v2_common_address": { "required": [ "address_line_1", "address_line_2", "admin_area_2", "admin_area_1", "postal_code", "country_code" ], "properties": { "address_line_1": { "description": "The first line of the address. For example, number or street. For example, 173 Drury Lane.\nRequired for data entry and compliance and risk checks. Must contain the full address.", "type": "string", "maxLength": 300, "nullable": true }, "address_line_2": { "description": "The second line of the address. For example, suite or apartment number.", "type": "string", "maxLength": 300, "nullable": true }, "admin_area_2": { "description": "A city, town, or village. Smaller than $adminArea1", "type": "string", "maxLength": 120, "nullable": true }, "admin_area_1": { "description": "The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.\nFormat for postal delivery. For example, CA and not California.", "type": "string", "maxLength": 300, "nullable": true }, "postal_code": { "type": "string", "maxLength": 60, "nullable": true }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 } }, "type": "object" }, "paypal_v2_common_link": { "required": ["href", "rel", "method", "enc_type"], "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "method": { "type": "string" }, "enc_type": { "type": "string", "nullable": true } }, "type": "object" }, "paypal_v2_common_money": { "required": ["currency_code", "value"], "properties": { "currency_code": { "type": "string", "maxLength": 3, "minLength": 3 }, "value": { "type": "string", "maxLength": 30 } }, "type": "object" }, "paypal_v2_common_name": { "required": ["given_name", "surname"], "properties": { "given_name": { "type": "string", "maxLength": 140 }, "surname": { "type": "string", "maxLength": 140 } }, "type": "object" }, "paypal_v2_common_phone_number": { "required": ["national_number", "country_code"], "properties": { "national_number": { "type": "string", "maxLength": 3, "minLength": 1 }, "country_code": { "type": "string", "maxLength": 14, "minLength": 1 } }, "type": "object" }, "paypal_v2_common_upc": { "required": ["type", "code"], "properties": { "type": { "type": "string", "maxLength": 5, "minLength": 1 }, "code": { "type": "string", "maxLength": 17, "minLength": 6 } }, "type": "object" }, "paypal_v2_order": { "required": [ "create_time", "update_time", "id", "intent", "payer", "purchase_units", "application_context", "payment_source", "status", "processing_instruction", "links" ], "properties": { "create_time": { "type": "string" }, "update_time": { "type": "string" }, "id": { "type": "string" }, "intent": { "type": "string", "enum": ["CAPTURE", "AUTHORIZE"] }, "payer": { "$ref": "#/components/schemas/paypal_v2_order_payer" }, "purchase_units": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit" }, "nullable": true }, "application_context": { "$ref": "#/components/schemas/paypal_v2_order_application_context" }, "payment_source": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source" } ], "nullable": true }, "status": { "type": "string" }, "processing_instruction": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } } }, "type": "object" }, "paypal_v2_order_application_context": { "required": ["brand_name", "return_url", "cancel_url"], "properties": { "brand_name": { "type": "string" }, "landing_page": { "type": "string", "default": "NO_PREFERENCE", "enum": ["LOGIN", "BILLING", "NO_PREFERENCE"] }, "shipping_preference": { "type": "string", "default": "SET_PROVIDED_ADDRESS", "enum": ["SET_PROVIDED_ADDRESS", "NO_SHIPPING", "GET_FROM_FILE"] }, "user_action": { "type": "string", "default": "PAY_NOW", "enum": ["CONTINUE", "PAY_NOW"] }, "return_url": { "type": "string" }, "cancel_url": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payer": { "required": ["name", "email_address", "payer_id", "phone", "address"], "properties": { "name": { "$ref": "#/components/schemas/paypal_v2_common_name" }, "email_address": { "type": "string" }, "payer_id": { "type": "string" }, "phone": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_phone" } ], "nullable": true }, "address": { "$ref": "#/components/schemas/paypal_v2_common_address" } }, "type": "object" }, "paypal_v2_order_payment_source": { "required": [ "apple_pay", "pay_upon_invoice", "bancontact", "blik", "boletobancario", "card", "eps", "ideal", "multibanco", "my_bank", "oxxo", "p_2_4", "paypal", "token", "trustly", "google_pay", "venmo" ], "properties": { "apple_pay": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_apple_pay" }, "pay_upon_invoice": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_pay_upon_invoice" } ], "nullable": true }, "bancontact": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_bancontact" } ], "nullable": true }, "blik": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_blik" } ], "nullable": true }, "boletobancario": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_boletobancario" } ], "nullable": true }, "card": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card" } ], "nullable": true }, "eps": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_eps" } ], "nullable": true }, "ideal": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_ideal" } ], "nullable": true }, "multibanco": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_multibanco" } ], "nullable": true }, "my_bank": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_my_bank" } ], "nullable": true }, "oxxo": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_oxxo" } ], "nullable": true }, "p_2_4": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_p24" } ], "nullable": true }, "paypal": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_paypal" } ], "nullable": true }, "token": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_token" } ], "nullable": true }, "trustly": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_trustly" } ], "nullable": true }, "google_pay": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_google_pay" } ], "nullable": true }, "venmo": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_venmo" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_apple_pay": { "required": [ "name", "country_code", "experience_context", "card", "attributes" ], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "card": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card" } ], "nullable": true }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_bancontact": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_blik": { "required": ["name", "country_code", "experience_context", "email"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_boletobancario": { "required": [ "name", "country_code", "experience_context", "email", "expiry_date", "tax_info", "billing_address" ], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email": { "type": "string" }, "expiry_date": { "type": "string" }, "tax_info": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_boletobancario_tax_info" }, "billing_address": { "$ref": "#/components/schemas/paypal_v2_common_address" } }, "type": "object" }, "paypal_v2_order_payment_source_boletobancario_tax_info": { "required": ["tax_id", "tax_id_type"], "properties": { "tax_id": { "type": "string" }, "tax_id_type": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_card": { "required": [ "name", "country_code", "experience_context", "last_digits", "brand", "type", "vault_id", "billing_address", "authentication_result", "attributes", "stored_credential" ], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "last_digits": { "type": "string" }, "brand": { "type": "string" }, "type": { "type": "string" }, "vault_id": { "type": "string" }, "billing_address": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_address" } ], "nullable": true }, "authentication_result": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card_authentication_result" } ], "nullable": true }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes" } ], "nullable": true }, "stored_credential": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card_stored_credential" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_card_authentication_result": { "required": ["liability_shift", "three_d_secure"], "properties": { "liability_shift": { "type": "string" }, "three_d_secure": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card_authentication_result_3d_secure" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_card_authentication_result_3d_secure": { "required": ["enrollment_status", "authentication_status"], "properties": { "enrollment_status": { "type": "string" }, "authentication_status": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_card_stored_credential": { "required": [ "payment_initiator", "payment_type", "usage", "previous_network_transaction_reference" ], "properties": { "payment_initiator": { "type": "string", "enum": ["MERCHANT", "CUSTOMER"] }, "payment_type": { "type": "string", "enum": ["RECURRING", "ONE_TIME", "UNSCHEDULED"] }, "usage": { "type": "string", "enum": ["DERIVED", "FIRST", "SUBSEQUENT"] }, "previous_network_transaction_reference": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_common_attributes": { "required": ["vault", "customer", "verification"], "properties": { "vault": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_vault" }, "customer": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_customer" }, "verification": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_verification" } }, "type": "object" }, "paypal_v2_order_payment_source_common_attributes_customer": { "required": ["id"], "properties": { "id": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_common_attributes_order_update_callback_config": { "required": ["callback_url", "callback_events"], "properties": { "callback_url": { "type": "string" }, "callback_events": { "type": "array", "items": { "type": "string", "enum": ["SHIPPING_ADDRESS", "SHIPPING_OPTIONS"] } } }, "type": "object" }, "paypal_v2_order_payment_source_common_attributes_vault": { "required": [ "id", "store_in_vault", "usage_type", "status", "confirm_payment_token", "permit_multiple_payment_tokens", "customer", "links" ], "properties": { "id": { "type": "string", "nullable": true }, "store_in_vault": { "type": "string" }, "usage_type": { "type": "string" }, "status": { "type": "string" }, "confirm_payment_token": { "type": "string" }, "permit_multiple_payment_tokens": { "type": "boolean" }, "customer": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_customer" } ], "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } } }, "type": "object" }, "paypal_v2_order_payment_source_common_attributes_verification": { "required": ["method"], "properties": { "method": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_common_experience_context": { "required": [ "locale", "brand_name", "logo_url", "return_url", "cancel_url", "payment_method_preference", "customer_service_instructions", "order_update_callback_config" ], "properties": { "locale": { "type": "string" }, "brand_name": { "type": "string" }, "logo_url": { "type": "string" }, "landing_page": { "type": "string", "default": "NO_PREFERENCE", "enum": ["LOGIN", "GUEST_CHECKOUT", "NO_PREFERENCE"] }, "shipping_preference": { "type": "string", "default": "SET_PROVIDED_ADDRESS", "enum": ["SET_PROVIDED_ADDRESS", "NO_SHIPPING", "GET_FROM_FILE"] }, "user_action": { "type": "string", "default": "PAY_NOW", "enum": ["CONTINUE", "PAY_NOW"] }, "return_url": { "type": "string" }, "cancel_url": { "type": "string" }, "payment_method_preference": { "description": "Only: PayPal Wallet", "type": "string", "enum": ["UNRESTRICTED", "IMMEDIATE_PAYMENT_REQUIRED"] }, "customer_service_instructions": { "description": "Only: PUI", "type": "array", "items": { "type": "string" } }, "order_update_callback_config": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_order_update_callback_config" } }, "type": "object" }, "paypal_v2_order_payment_source_common_phone": { "required": ["phone_type", "phone_number"], "properties": { "phone_type": { "type": "string" }, "phone_number": { "$ref": "#/components/schemas/paypal_v2_common_phone_number" } }, "type": "object" }, "paypal_v2_order_payment_source_eps": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_google_pay": { "required": ["experience_context", "card", "attributes"], "properties": { "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "card": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_card" } ], "nullable": true }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_ideal": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_multibanco": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_my_bank": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_oxxo": { "required": ["name", "country_code", "experience_context", "email"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_p24": { "required": ["name", "country_code", "experience_context", "email"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_pay_upon_invoice": { "required": [ "experience_context", "name", "email", "birth_date", "phone", "billing_address", "payment_reference", "deposit_bank_details" ], "properties": { "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "name": { "$ref": "#/components/schemas/paypal_v2_common_name" }, "email": { "type": "string" }, "birth_date": { "type": "string" }, "phone": { "$ref": "#/components/schemas/paypal_v2_common_phone_number" }, "billing_address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "payment_reference": { "type": "string" }, "deposit_bank_details": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_pay_upon_invoice_deposit_bank_details" } }, "type": "object" }, "paypal_v2_order_payment_source_pay_upon_invoice_deposit_bank_details": { "required": ["bic", "bank_name", "iban", "account_holder_name"], "properties": { "bic": { "type": "string" }, "bank_name": { "type": "string" }, "iban": { "type": "string" }, "account_holder_name": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_paypal": { "required": [ "experience_context", "email_address", "account_id", "billing_agreement_id", "vault_id", "name", "phone_number", "address", "birth_date", "phone_type", "attributes" ], "properties": { "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email_address": { "type": "string" }, "account_id": { "type": "string" }, "billing_agreement_id": { "type": "string" }, "vault_id": { "type": "string" }, "name": { "$ref": "#/components/schemas/paypal_v2_common_name" }, "phone_number": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_phone_number" } ], "nullable": true }, "address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "birth_date": { "type": "string" }, "phone_type": { "type": "string" }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_payment_source_token": { "required": [ "experience_context", "id", "type", "stored_payment_source" ], "properties": { "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "id": { "type": "string" }, "type": { "type": "string" }, "stored_payment_source": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_token_stored_payment_source" } }, "type": "object" }, "paypal_v2_order_payment_source_token_stored_payment_source": { "required": ["payment_initiator", "payment_type", "usage"], "properties": { "payment_initiator": { "type": "string" }, "payment_type": { "type": "string" }, "usage": { "type": "string" } }, "type": "object" }, "paypal_v2_order_payment_source_trustly": { "required": ["name", "country_code", "experience_context"], "properties": { "name": { "type": "string", "maxLength": 300, "minLength": 3 }, "country_code": { "type": "string", "maxLength": 2, "minLength": 2 }, "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" } }, "type": "object" }, "paypal_v2_order_payment_source_venmo": { "required": [ "experience_context", "email_address", "user_name", "account_id", "vault_id", "name", "phone_number", "address", "attributes" ], "properties": { "experience_context": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_experience_context" }, "email_address": { "type": "string" }, "user_name": { "type": "string" }, "account_id": { "type": "string" }, "vault_id": { "type": "string" }, "name": { "$ref": "#/components/schemas/paypal_v2_common_name" }, "phone_number": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_phone_number" } ], "nullable": true }, "address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "attributes": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes" } ], "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit": { "required": [ "reference_id", "amount", "payee", "description", "custom_id", "invoice_id", "items", "shipping", "payments", "supplementary_data", "shipping_options" ], "properties": { "reference_id": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_amount" }, "payee": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payee" }, "description": { "type": "string" }, "custom_id": { "type": "string", "nullable": true }, "invoice_id": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_item" }, "nullable": true }, "shipping": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping" }, "payments": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments" } ], "nullable": true }, "supplementary_data": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data" }, "shipping_options": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping_option" }, "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_amount": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/paypal_v2_common_money" }, { "required": ["breakdown"], "properties": { "breakdown": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_amount_breakdown" } ], "nullable": true } }, "type": "object" } ] }, "paypal_v2_order_purchase_unit_amount_breakdown": { "required": [ "item_total", "shipping", "handling", "tax_total", "insurance", "shipping_discount", "discount" ], "properties": { "item_total": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "shipping": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "handling": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "tax_total": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_money" } ], "nullable": true }, "insurance": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "shipping_discount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "discount": { "$ref": "#/components/schemas/paypal_v2_common_money" } }, "type": "object" }, "paypal_v2_order_purchase_unit_item": { "required": [ "name", "unit_amount", "tax", "tax_rate", "category", "quantity", "sku" ], "properties": { "name": { "type": "string", "maxLength": 120 }, "unit_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "tax": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "tax_rate": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "float" } ] }, "category": { "type": "string", "enum": ["PHYSICAL_GOODS", "DIGITAL_GOODS", "DONATION"] }, "quantity": { "type": "integer" }, "sku": { "type": "string", "maxLength": 127, "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_payee": { "required": ["email_address", "merchant_id", "display_data"], "properties": { "email_address": { "type": "string" }, "merchant_id": { "type": "string" }, "display_data": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payee_display_data" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payee_display_data": { "required": ["brand_name"], "properties": { "brand_name": { "type": "string" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments": { "required": ["authorizations", "captures", "refunds"], "properties": { "authorizations": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_authorization" }, "nullable": true }, "captures": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture" }, "nullable": true }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_refund" }, "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_authorization": { "required": [ "status", "id", "amount", "custom_id", "links", "create_time", "update_time", "seller_protection", "expiration_time" ], "properties": { "status": { "type": "string" }, "id": { "type": "string" }, "amount": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_money" } ], "nullable": true }, "custom_id": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "seller_protection": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_common_seller_protection" }, "expiration_time": { "type": "string" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_authorization_seller_protection": { "required": ["status", "dispute_categories"], "properties": { "status": { "type": "string" }, "dispute_categories": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_capture": { "required": [ "status", "id", "amount", "custom_id", "links", "create_time", "update_time", "invoice_id", "note_to_payer", "seller_protection", "final_capture", "seller_receivable_breakdown", "processor_response", "disbursement_mode" ], "properties": { "status": { "type": "string" }, "id": { "type": "string" }, "amount": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_money" } ], "nullable": true }, "custom_id": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "invoice_id": { "type": "string", "maxLength": 127, "nullable": true }, "note_to_payer": { "type": "string", "maxLength": 255, "nullable": true }, "seller_protection": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_common_seller_protection" }, "final_capture": { "type": "boolean" }, "seller_receivable_breakdown": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture_seller_receivable_breakdown" }, "processor_response": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_capture_processor_response" }, "disbursement_mode": { "type": "string" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_capture_processor_response": { "required": ["avs_code", "cvv_code", "response_code"], "properties": { "avs_code": { "type": "string", "nullable": true }, "cvv_code": { "type": "string", "nullable": true }, "response_code": { "type": "string", "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_capture_seller_receivable_breakdown": { "required": ["gross_amount", "paypal_fee", "net_amount"], "properties": { "gross_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "paypal_fee": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "net_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_common_seller_protection": { "required": ["status", "dispute_categories"], "properties": { "status": { "type": "string" }, "dispute_categories": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_refund": { "required": [ "status", "id", "amount", "custom_id", "links", "create_time", "update_time", "invoice_id", "note_to_payer", "seller_payable_breakdown" ], "properties": { "status": { "type": "string" }, "id": { "type": "string" }, "amount": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v2_common_money" } ], "nullable": true }, "custom_id": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } }, "create_time": { "type": "string" }, "update_time": { "type": "string" }, "invoice_id": { "type": "string", "maxLength": 127, "nullable": true }, "note_to_payer": { "type": "string", "maxLength": 255, "nullable": true }, "seller_payable_breakdown": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_payments_refund_seller_payable_breakdown" } }, "type": "object" }, "paypal_v2_order_purchase_unit_payments_refund_seller_payable_breakdown": { "required": [ "gross_amount", "paypal_fee", "net_amount", "total_refunded_amount" ], "properties": { "gross_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "paypal_fee": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "net_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "total_refunded_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" } }, "type": "object" }, "paypal_v2_order_purchase_unit_shipping": { "required": ["name", "address", "trackers"], "properties": { "name": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping_name" }, "address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "trackers": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping_tracker" }, "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_shipping_name": { "required": ["full_name"], "properties": { "full_name": { "type": "string" } }, "type": "object" }, "paypal_v2_order_purchase_unit_shipping_tracker": { "required": ["id", "status", "notify_payer", "links", "items"], "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "notify_payer": { "type": "boolean" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_item" } } }, "type": "object" }, "paypal_v2_order_purchase_unit_shipping_tracker_item": { "required": ["name", "quantity", "sku", "url", "image_url"], "properties": { "name": { "type": "string", "maxLength": 120 }, "quantity": { "type": "integer" }, "sku": { "type": "string", "maxLength": 127, "nullable": true }, "url": { "type": "string", "maxLength": 2048, "nullable": true }, "image_url": { "type": "string", "maxLength": 2048, "nullable": true } }, "type": "object" }, "paypal_v2_order_purchase_unit_shipping_option": { "required": ["id", "label", "amount", "type", "selected"], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "type": { "type": "string", "enum": ["SHIPPING", "PICKUP"] }, "selected": { "type": "boolean" } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data": { "required": ["card", "risk"], "properties": { "card": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data_card" }, "risk": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data_risk" } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_card": { "required": ["address"], "properties": { "address": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data_card_level2" } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_card_level2": { "required": ["invoice_id", "tax_total"], "properties": { "invoice_id": { "type": "string" }, "tax_total": { "$ref": "#/components/schemas/paypal_v2_common_money" } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_card_level3": { "required": [ "shipping_amount", "duty_amount", "discount_amount", "shipping_address", "ships_from_postal_code", "line_items" ], "properties": { "shipping_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "duty_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "discount_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "shipping_address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "ships_from_postal_code": { "type": "string" }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data_card_line_item" } } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_card_line_item": { "required": [ "name", "quantity", "description", "sku", "url", "image_url", "upc", "unit_amount", "tax", "commodity_code", "discount_amount", "total_amount", "unit_of_measure" ], "properties": { "name": { "type": "string", "maxLength": 127, "minLength": 1 }, "quantity": { "type": "integer" }, "description": { "type": "string", "maxLength": 2048 }, "sku": { "type": "string", "maxLength": 127 }, "url": { "type": "string", "maxLength": 2048, "minLength": 1 }, "image_url": { "type": "string", "maxLength": 2048, "minLength": 1 }, "upc": { "$ref": "#/components/schemas/paypal_v2_common_upc" }, "unit_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "tax": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "commodity_code": { "type": "string", "maxLength": 12, "minLength": 1 }, "discount_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "total_amount": { "$ref": "#/components/schemas/paypal_v2_common_money" }, "unit_of_measure": { "type": "string", "maxLength": 12, "minLength": 1 } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_risk": { "required": ["address"], "properties": { "address": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_supplementary_data_risk_participant_metadata" } }, "type": "object" }, "paypal_v2_order_purchase_unit_supplementary_data_risk_participant_metadata": { "required": ["ip_address"], "properties": { "ip_address": { "type": "string", "maxLength": 37, "minLength": 7 } }, "type": "object" }, "paypal_v2_order_tracker": { "required": [ "capture_id", "tracking_number", "carrier", "carrier_name_other", "items" ], "properties": { "capture_id": { "type": "string" }, "tracking_number": { "type": "string", "maxLength": 64 }, "carrier": { "type": "string" }, "carrier_name_other": { "type": "string", "nullable": true }, "notify_payer": { "type": "boolean", "default": false }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping_tracker_item" } } }, "type": "object" }, "paypal_v2_order_shipping_callback": { "required": [ "id", "shipping_address", "shipping_option", "purchase_units" ], "properties": { "id": { "type": "string" }, "shipping_address": { "$ref": "#/components/schemas/paypal_v2_common_address" }, "shipping_option": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit_shipping_option" }, "purchase_units": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_order_purchase_unit" } } }, "type": "object" }, "paypal_v2_patch": { "required": ["op", "path", "value", "from"], "properties": { "op": { "type": "string" }, "path": { "type": "string" }, "value": { "type": "array", "items": [], "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "float" }, { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "mixed" } } ] }, "from": { "type": "string" } }, "type": "object" }, "paypal_v2_referral": { "required": [ "business_entity", "preferred_language_code", "tracking_id", "partner_config_override", "operations", "products", "capabilities", "legal_consents", "links" ], "properties": { "business_entity": { "$ref": "#/components/schemas/paypal_v2_referral_business_entity" }, "preferred_language_code": { "type": "string" }, "tracking_id": { "type": "string" }, "partner_config_override": { "$ref": "#/components/schemas/paypal_v2_referral_partner_config_override" }, "operations": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_referral_operation" } }, "products": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "array", "items": { "type": "string" } }, "legal_consents": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_referral_legal_consent" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } } }, "type": "object" }, "paypal_v2_referral_business_entity": { "required": ["addresses"], "properties": { "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_referral_business_entity_address" } } }, "type": "object" }, "paypal_v2_referral_business_entity_address": { "required": ["country_code"], "properties": { "country_code": { "type": "string" }, "type": { "type": "string", "default": "WORK" } }, "type": "object" }, "paypal_v2_referral_legal_consent": { "required": ["granted"], "properties": { "type": { "type": "string", "default": "SHARE_DATA_CONSENT" }, "granted": { "type": "boolean" } }, "type": "object" }, "paypal_v2_referral_operation": { "required": ["api_integration_preference"], "properties": { "operation": { "type": "string", "default": "API_INTEGRATION" }, "api_integration_preference": { "$ref": "#/components/schemas/paypal_v2_referral_operation_api_integration_preference" } }, "type": "object" }, "paypal_v2_referral_operation_api_integration_preference": { "required": ["rest_api_integration"], "properties": { "rest_api_integration": { "$ref": "#/components/schemas/paypal_v2_referral_operation_api_integration_preference_rest_api_integration" } }, "type": "object" }, "paypal_v2_referral_operation_api_integration_preference_rest_api_integration": { "required": ["third_party_details"], "properties": { "integration_method": { "type": "string", "default": "PAYPAL" }, "integration_type": { "type": "string", "default": "THIRD_PARTY" }, "third_party_details": { "$ref": "#/components/schemas/paypal_v2_referral_operation_api_integration_preference_rest_api_integration_third_party_details" } }, "type": "object" }, "paypal_v2_referral_operation_api_integration_preference_rest_api_integration_third_party_details": { "required": ["features"], "properties": { "features": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "paypal_v2_referral_partner_config_override": { "required": ["return_url", "partner_logo_url"], "properties": { "return_url": { "type": "string" }, "partner_logo_url": { "type": "string" } }, "type": "object" }, "paypal_v3_payment_token": { "required": [ "id", "status", "customer", "payment_source", "links", "metadata" ], "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "customer": { "$ref": "#/components/schemas/paypal_v2_order_payment_source_common_attributes_customer" }, "payment_source": { "$ref": "#/components/schemas/paypal_v2_order_payment_source" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/paypal_v2_common_link" } }, "metadata": { "oneOf": [ { "$ref": "#/components/schemas/paypal_v3_payment_token_metadata" } ], "nullable": true } }, "type": "object" }, "paypal_v3_payment_token_metadata": { "required": ["order_id"], "properties": { "order_id": { "type": "string" } }, "type": "object" } }, "responses": { "204": { "description": "No Content" }, "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." } ] } } } }, "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." } ] } } } }, "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." } ] } } } }, "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." } ] } } } }, "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": "https://demo-frontends.shopware.store/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": "Admin Api", "description": "Admin Api" }, { "name": "SwagPayPalPaymentMethod", "description": "SwagPayPalPaymentMethod" }, { "name": "Admin API", "description": "Admin API" }, { "name": "PayPal", "description": "PayPal" }, { "name": "SwagPayPalPosWebhook", "description": "SwagPayPalPosWebhook" }, { "name": "SwagPayPalWebhook", "description": "SwagPayPalWebhook" }, { "name": "Advanced Search Entity Stream Filter", "description": "The endpoint for operations on Advanced Search Entity Stream Filter" }, { "name": "Advanced Search Synonym", "description": "The endpoint for operations on Advanced Search Synonym" }, { "name": "App", "description": "The endpoint for operations on App" }, { "name": "App Action Button", "description": "The endpoint for operations on App Action Button" }, { "name": "App Administration Snippet", "description": "The endpoint for operations on App Administration Snippet" }, { "name": "App Cms Block", "description": "The endpoint for operations on App Cms Block" }, { "name": "App Flow Action", "description": "The endpoint for operations on App Flow Action" }, { "name": "App Flow Event", "description": "The endpoint for operations on App Flow Event" }, { "name": "App Payment Method", "description": "The endpoint for operations on App Payment Method" }, { "name": "App Script Condition", "description": "The endpoint for operations on App Script Condition" }, { "name": "App Shipping Method", "description": "The endpoint for operations on App Shipping Method" }, { "name": "App Template", "description": "The endpoint for operations on App Template" }, { "name": "B2b Business Partner", "description": "The endpoint for operations on B2b Business Partner" }, { "name": "B2b Components Advanced Product Catalogs", "description": "The endpoint for operations on B2b Components Advanced Product Catalogs" }, { "name": "B2b Components Approval Rule", "description": "The endpoint for operations on B2b Components Approval Rule" }, { "name": "B2b Components Approval Rule App Script Condition", "description": "The endpoint for operations on B2b Components Approval Rule App Script Condition" }, { "name": "B2b Components Budget", "description": "The endpoint for operations on B2b Components Budget" }, { "name": "B2b Components Employee Wishlist", "description": "The endpoint for operations on B2b Components Employee Wishlist" }, { "name": "B2b Components Employee Wishlist Product", "description": "The endpoint for operations on B2b Components Employee Wishlist Product" }, { "name": "B2b Components Organization", "description": "The endpoint for operations on B2b Components Organization" }, { "name": "B2b Components Organization Customer Address", "description": "The endpoint for operations on B2b Components Organization Customer Address" }, { "name": "B2b Components Pending Order", "description": "The endpoint for operations on B2b Components Pending Order" }, { "name": "B2b Components Pending Order Address", "description": "The endpoint for operations on B2b Components Pending Order Address" }, { "name": "B2b Components Role", "description": "The endpoint for operations on B2b Components Role" }, { "name": "B2b Components Shopping List", "description": "The endpoint for operations on B2b Components Shopping List" }, { "name": "B2b Components Shopping List Line Item", "description": "The endpoint for operations on B2b Components Shopping List Line Item" }, { "name": "B2b Employee", "description": "The endpoint for operations on B2b Employee" }, { "name": "B2b Order Employee", "description": "The endpoint for operations on B2b Order Employee" }, { "name": "B2b Permission", "description": "The endpoint for operations on B2b Permission" }, { "name": "Category", "description": "The endpoint for operations on Category" }, { "name": "Ce Spatial Preview", "description": "The endpoint for operations on Ce Spatial Preview" }, { "name": "Cms Block", "description": "The endpoint for operations on Cms Block" }, { "name": "Cms Page", "description": "The endpoint for operations on Cms Page" }, { "name": "Cms Page Activity", "description": "The endpoint for operations on Cms Page Activity" }, { "name": "Cms Page Draft", "description": "The endpoint for operations on Cms Page Draft" }, { "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": "Custom Price", "description": "The endpoint for operations on Custom Price" }, { "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 Specific Features", "description": "The endpoint for operations on Customer Specific Features" }, { "name": "Customer Wishlist", "description": "The endpoint for operations on Customer Wishlist" }, { "name": "Customer Wishlist Product", "description": "The endpoint for operations on Customer Wishlist Product" }, { "name": "Delivery Time", "description": "The endpoint for operations on Delivery Time" }, { "name": "Document", "description": "The endpoint for operations on Document" }, { "name": "Document Base Config", "description": "The endpoint for operations on Document Base Config" }, { "name": "Document Base Config Sales Channel", "description": "The endpoint for operations on Document Base Config Sales Channel" }, { "name": "Document Type", "description": "The endpoint for operations on Document Type" }, { "name": "Dsr Appointment", "description": "The endpoint for operations on Dsr Appointment" }, { "name": "Dsr Appointment Attendee", "description": "The endpoint for operations on Dsr Appointment Attendee" }, { "name": "Dsr Appointment Request", "description": "The endpoint for operations on Dsr Appointment Request" }, { "name": "Dsr Appointment Video Chat", "description": "The endpoint for operations on Dsr Appointment Video Chat" }, { "name": "Dsr Attendee Product Collection", "description": "The endpoint for operations on Dsr Attendee Product Collection" }, { "name": "Dsr Cms Slide", "description": "The endpoint for operations on Dsr Cms Slide" }, { "name": "Dsr Interaction", "description": "The endpoint for operations on Dsr Interaction" }, { "name": "Dsr Presentation", "description": "The endpoint for operations on Dsr Presentation" }, { "name": "Dsr Presentation Cms Page", "description": "The endpoint for operations on Dsr Presentation Cms Page" }, { "name": "Flow", "description": "The endpoint for operations on Flow" }, { "name": "Flow Sequence", "description": "The endpoint for operations on Flow Sequence" }, { "name": "Flow Template", "description": "The endpoint for operations on Flow Template" }, { "name": "Import Export File", "description": "The endpoint for operations on Import Export File" }, { "name": "Import Export Log", "description": "The endpoint for operations on Import Export Log" }, { "name": "Import Export Profile", "description": "The endpoint for operations on Import Export Profile" }, { "name": "Integration", "description": "The endpoint for operations on Integration" }, { "name": "Landing Page", "description": "The endpoint for operations on Landing Page" }, { "name": "Language", "description": "The endpoint for operations on Language" }, { "name": "Locale", "description": "The endpoint for operations on Locale" }, { "name": "Log Entry", "description": "The endpoint for operations on Log Entry" }, { "name": "Mail Header Footer", "description": "The endpoint for operations on Mail Header Footer" }, { "name": "Mail Template", "description": "The endpoint for operations on Mail Template" }, { "name": "Mail Template Type", "description": "The endpoint for operations on Mail Template Type" }, { "name": "Main Category", "description": "The endpoint for operations on Main Category" }, { "name": "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 Ai Tag", "description": "The endpoint for operations on Media Ai Tag" }, { "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 Product Warehouse", "description": "The endpoint for operations on Order Product Warehouse" }, { "name": "Order Return", "description": "The endpoint for operations on Order Return" }, { "name": "Order Return Line Item", "description": "The endpoint for operations on Order Return Line Item" }, { "name": "Order Return Line Item Reason", "description": "The endpoint for operations on Order Return Line Item Reason" }, { "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": "Order Warehouse Group", "description": "The endpoint for operations on Order Warehouse Group" }, { "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 Review Summary", "description": "The endpoint for operations on Product Review Summary" }, { "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": "Product Warehouse", "description": "The endpoint for operations on Product Warehouse" }, { "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": "Quote", "description": "The endpoint for operations on Quote" }, { "name": "Quote Comment", "description": "The endpoint for operations on Quote Comment" }, { "name": "Quote Delivery", "description": "The endpoint for operations on Quote Delivery" }, { "name": "Quote Delivery Position", "description": "The endpoint for operations on Quote Delivery Position" }, { "name": "Quote Document", "description": "The endpoint for operations on Quote Document" }, { "name": "Quote Employee", "description": "The endpoint for operations on Quote Employee" }, { "name": "Quote Line Item", "description": "The endpoint for operations on Quote Line Item" }, { "name": "Quote Transaction", "description": "The endpoint for operations on Quote Transaction" }, { "name": "Rule", "description": "The endpoint for operations on Rule" }, { "name": "Rule Condition", "description": "The endpoint for operations on Rule Condition" }, { "name": "Saas App Storefront Config", "description": "The endpoint for operations on Saas App Storefront Config" }, { "name": "Saas Storefront Demo Token", "description": "The endpoint for operations on Saas Storefront Demo Token" }, { "name": "Sales Channel", "description": "The endpoint for operations on Sales Channel" }, { "name": "Sales Channel Analytics", "description": "The endpoint for operations on Sales Channel Analytics" }, { "name": "Sales Channel Domain", "description": "The endpoint for operations on Sales Channel Domain" }, { "name": "Sales Channel Type", "description": "The endpoint for operations on Sales Channel Type" }, { "name": "Salutation", "description": "The endpoint for operations on Salutation" }, { "name": "Scheduled Task", "description": "The endpoint for operations on Scheduled Task" }, { "name": "Script", "description": "The endpoint for operations on Script" }, { "name": "Seo Url", "description": "The endpoint for operations on Seo Url" }, { "name": "Seo Url Template", "description": "The endpoint for operations on Seo Url Template" }, { "name": "Shipping Method", "description": "The endpoint for operations on Shipping Method" }, { "name": "Shipping Method Price", "description": "The endpoint for operations on Shipping Method Price" }, { "name": "Snippet", "description": "The endpoint for operations on Snippet" }, { "name": "Snippet Set", "description": "The endpoint for operations on Snippet Set" }, { "name": "Spatial Render Config Size", "description": "The endpoint for operations on Spatial Render Config Size" }, { "name": "Spatial Scene", "description": "The endpoint for operations on Spatial Scene" }, { "name": "Spatial Scene Camera", "description": "The endpoint for operations on Spatial Scene Camera" }, { "name": "Spatial Scene Group", "description": "The endpoint for operations on Spatial Scene Group" }, { "name": "Spatial Scene Light", "description": "The endpoint for operations on Spatial Scene Light" }, { "name": "Spatial Scene Material", "description": "The endpoint for operations on Spatial Scene Material" }, { "name": "Spatial Scene Object", "description": "The endpoint for operations on Spatial Scene Object" }, { "name": "Spatial Scene Primitive", "description": "The endpoint for operations on Spatial Scene Primitive" }, { "name": "Sso Provider", "description": "The endpoint for operations on Sso Provider" }, { "name": "Sso Provider Customer", "description": "The endpoint for operations on Sso Provider Customer" }, { "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": "Subscription", "description": "The endpoint for operations on Subscription" }, { "name": "Subscription Address", "description": "The endpoint for operations on Subscription Address" }, { "name": "Subscription Customer", "description": "The endpoint for operations on Subscription Customer" }, { "name": "Subscription Interval", "description": "The endpoint for operations on Subscription Interval" }, { "name": "Subscription Plan", "description": "The endpoint for operations on Subscription Plan" }, { "name": "Swag Cms Extensions Block Rule", "description": "The endpoint for operations on Swag Cms Extensions Block Rule" }, { "name": "Swag Cms Extensions Form", "description": "The endpoint for operations on Swag Cms Extensions Form" }, { "name": "Swag Cms Extensions Form Group", "description": "The endpoint for operations on Swag Cms Extensions Form Group" }, { "name": "Swag Cms Extensions Form Group Field", "description": "The endpoint for operations on Swag Cms Extensions Form Group Field" }, { "name": "Swag Cms Extensions Quickview", "description": "The endpoint for operations on Swag Cms Extensions Quickview" }, { "name": "Swag Cms Extensions Scroll Navigation", "description": "The endpoint for operations on Swag Cms Extensions Scroll Navigation" }, { "name": "Swag Cms Extensions Scroll Navigation Page Settings", "description": "The endpoint for operations on Swag Cms Extensions Scroll Navigation Page Settings" }, { "name": "Swag Customized Products Template", "description": "The endpoint for operations on Swag Customized Products Template" }, { "name": "Swag Customized Products Template Configuration", "description": "The endpoint for operations on Swag Customized Products Template Configuration" }, { "name": "Swag Customized Products Template Configuration Share", "description": "The endpoint for operations on Swag Customized Products Template Configuration Share" }, { "name": "Swag Customized Products Template Exclusion", "description": "The endpoint for operations on Swag Customized Products Template Exclusion" }, { "name": "Swag Customized Products Template Exclusion Condition", "description": "The endpoint for operations on Swag Customized Products Template Exclusion Condition" }, { "name": "Swag Customized Products Template Exclusion Operator", "description": "The endpoint for operations on Swag Customized Products Template Exclusion Operator" }, { "name": "Swag Customized Products Template Option", "description": "The endpoint for operations on Swag Customized Products Template Option" }, { "name": "Swag Customized Products Template Option Price", "description": "The endpoint for operations on Swag Customized Products Template Option Price" }, { "name": "Swag Customized Products Template Option Value", "description": "The endpoint for operations on Swag Customized Products Template Option Value" }, { "name": "Swag Customized Products Template Option Value Price", "description": "The endpoint for operations on Swag Customized Products Template Option Value Price" }, { "name": "Swag Delay Action", "description": "The endpoint for operations on Swag Delay Action" }, { "name": "Swag Language Pack Language", "description": "The endpoint for operations on Swag Language Pack Language" }, { "name": "Swag Migration Connection", "description": "The endpoint for operations on Swag Migration Connection" }, { "name": "Swag Migration Data", "description": "The endpoint for operations on Swag Migration Data" }, { "name": "Swag Migration General Setting", "description": "The endpoint for operations on Swag Migration General Setting" }, { "name": "Swag Migration Logging", "description": "The endpoint for operations on Swag Migration Logging" }, { "name": "Swag Migration Mapping", "description": "The endpoint for operations on Swag Migration Mapping" }, { "name": "Swag Migration Media File", "description": "The endpoint for operations on Swag Migration Media File" }, { "name": "Swag Migration Run", "description": "The endpoint for operations on Swag Migration Run" }, { "name": "Swag Paypal Pos Sales Channel", "description": "The endpoint for operations on Swag Paypal Pos Sales Channel" }, { "name": "Swag Paypal Pos Sales Channel Run", "description": "The endpoint for operations on Swag Paypal Pos Sales Channel Run" }, { "name": "Swag Paypal Pos Sales Channel Run Log", "description": "The endpoint for operations on Swag Paypal Pos Sales Channel Run Log" }, { "name": "Swag Paypal Transaction Report", "description": "The endpoint for operations on Swag Paypal Transaction Report" }, { "name": "Swag Paypal Vault Token", "description": "The endpoint for operations on Swag Paypal Vault Token" }, { "name": "Swag Paypal Vault Token Mapping", "description": "The endpoint for operations on Swag Paypal Vault Token Mapping" }, { "name": "Swag Social Shopping Customer", "description": "The endpoint for operations on Swag Social Shopping Customer" }, { "name": "Swag Social Shopping Order", "description": "The endpoint for operations on Swag Social Shopping Order" }, { "name": "Swag Social Shopping Product Error", "description": "The endpoint for operations on Swag Social Shopping Product Error" }, { "name": "Swag Social Shopping Sales Channel", "description": "The endpoint for operations on Swag Social Shopping Sales Channel" }, { "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": "Warehouse", "description": "The endpoint for operations on Warehouse" }, { "name": "Warehouse Group", "description": "The endpoint for operations on Warehouse Group" }, { "name": "Webhook", "description": "The endpoint for operations on Webhook" }, { "name": "Webhook Event Log", "description": "The endpoint for operations on Webhook Event Log" } ] }