{ "openapi": "3.0.1", "info": { "title": "Future Ordering API", "contact": { "name": "Future Ordering Integration Support", "url": "https://developer.futureordering.com" } }, "servers": [ { "url": "https://api.futureordering.com", "description": "Production Environment API" }, { "url": "https://api-test.futureordering.com", "description": "Test Environment API" } ], "paths": { "/entities/{entity}/configs": { "post": { "summary": "Create new config item", "description": "Create new config item", "operationId": "post-configuration-v1-configs", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Config input model. Id and references", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigInputModel" }, "example": { "id": "string", "extensionReferences": [ { "publisher": "string", "dataId": "string", "version": "string" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "Get config for current tenant", "description": "Get config for current tenant", "operationId": "get-configuration-v1-configs", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Whether deleted items should be included or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Update a config item", "description": "Update a config item", "operationId": "put-configuration-v1-configs", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Config input model. Id and references", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigInputModel" }, "example": { "id": "string", "extensionReferences": [ { "publisher": "string", "dataId": "string", "version": "string" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/configs/dry-run": { "post": { "summary": "\"WhatIf\"-Create new config item. Nothing is saved, just a dry-run", "description": "\"WhatIf\"-Create new config item. Nothing is saved, just a dry-run", "operationId": "post-configuration-v1-configs-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Config input model. Id and references", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigInputModel" }, "example": { "id": "string", "extensionReferences": [ { "publisher": "string", "dataId": "string", "version": "string" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "\"WhatIf\"-Update a config item. Nothing is saved, just a dry-run", "description": "\"WhatIf\"-Update a config item. Nothing is saved, just a dry-run", "operationId": "put-configuration-v1-configs-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Config input model. Id and references", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigInputModel" }, "example": { "id": "string", "extensionReferences": [ { "publisher": "string", "dataId": "string", "version": "string" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/configs/versions": { "get": { "summary": "Get a list of previous versions", "description": "Get a list of previous versions", "operationId": "get-configuration-v1-configs-versions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Format - int32. How many versions to get. Default: 1", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "include_deleted", "in": "query", "description": "Whether deleted items should be included or not", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Whether to include info about DataTypes or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/configs/versions/{version}": { "get": { "summary": "Get specific version of tenant config", "description": "Get specific version of tenant config", "operationId": "get-configuration-v1-configs-versions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Format - int32. What version to get", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/connections": { "post": { "summary": "Create new connections for specified object", "description": "Create new connections for specified object", "operationId": "post-configuration-v1-connections", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body with info about how new connection should look like", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_DataConnectionInputModel" }, "example": { "id": "string", "entityType": "Type" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataConnectionOutputModel" }, "example": { "entityType": "Type", "publisher": "string", "id": "string", "lastUpdateDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "Get list of `Type`:s (`entity_type`) connected to a certain id (`entity_id`)", "description": "Get list of `Type`:s (`entity_type`) connected to a certain id (`entity_id`)", "operationId": "get-configuration-v1-connections", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entity_id", "in": "query", "description": "Id to look for", "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "description": "Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference", "schema": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string" } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Pagination parameter", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataConnectionOutputModel" } }, "example": [ { "entityType": "Type", "publisher": "string", "id": "string", "lastUpdateDate": {} } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/connections/{id}": { "delete": { "summary": "Delete connection for specified object", "description": "Delete connection for specified object", "operationId": "delete-configuration-v1-connections-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of object of interest", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "description": "Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference", "schema": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataConnectionOutputModel" }, "example": { "entityType": "Type", "publisher": "string", "id": "string", "lastUpdateDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "Get all connections to specified object", "description": "Get all connections to specified object", "operationId": "get-configuration-v1-connections-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of object of interest", "required": true, "schema": { "type": "string" } }, { "name": "entity_type", "in": "query", "description": "Type of connection. Valid values are: Type, Extension, Config, Schema, Value, Reference", "schema": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Specify if deleted schema should be retrieved", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataConnectionOutputModel" }, "example": { "entityType": "Type", "publisher": "string", "id": "string", "lastUpdateDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Update connections for specified object", "description": "Update connections for specified object", "operationId": "put-configuration-v1-connections-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "id of object of interest", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Body with info about how new connection should look like", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_DataConnectionInputModel" }, "example": { "id": "string", "entityType": "Type" } } } }, "responses": { "200": { "description": "Success" }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/extensions": { "post": { "summary": "Create new extension", "description": "Create new extension", "operationId": "post-configuration-v1-extensions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Content of extension to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionInputModel" }, "example": { "id": "string", "version": "string", "availability": "Private", "extensionReferences": {} } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "List all extensions", "description": "List all extensions", "operationId": "get-configuration-v1-extensions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether only published extensions should be included or not", "schema": { "type": "boolean", "default": false } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Pagination property", "schema": { "type": "string", "format": "date-time" } }, { "name": "complete", "in": "query", "description": "Use complete model", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IExtensionMinimalOutputModel" } }, "example": [ { "availability": "Private", "baseType": "Type", "publisher": "string", "id": "string", "version": "string" } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/extensions/{id}": { "get": { "summary": "Get specific extension", "description": "Get specific extension", "operationId": "get-configuration-v1-extensions-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether only published extensions should be included or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "delete": { "summary": "Mark extension as removed", "description": "Mark extension as removed", "operationId": "delete-configuration-v1-extensions-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Update existing extension", "description": "Update existing extension", "operationId": "put-configuration-v1-extensions-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted extensions", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Content of extension to change to", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionInputModel" }, "example": { "id": "string", "version": "string", "availability": "Private", "extensionReferences": {} } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/extensions/{id}/internalversions/{version}": { "get": { "summary": "Get a specific version of an extension where internalVersion is used instead (integer)", "description": "Get a specific version of an extension where internalVersion is used instead (integer)", "operationId": "get-configuration-v1-extensions-id-internalversions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Format - int32. Which particular version expected", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include relational extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether only published extensions should be included or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/extensions/{id}/versions": { "get": { "summary": "GET a list[{take}] of Extensions with {id}", "description": "GET a list[{take}] of Extensions with {id}", "operationId": "get-configuration-v1-extensions-id-versions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Format - int32. Number of versions", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "include_deleted", "in": "query", "description": "Include deleted extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include relational extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether only published extensions should be included or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/extensions/{id}/versions/{version}": { "get": { "summary": "Get a specific version of an extension", "description": "Get a specific version of an extension", "operationId": "get-configuration-v1-extensions-id-versions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of extension", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Which particular version expected", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted parameters", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include relational extensions", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether only published extensions should be included or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/health": { "get": { "summary": "/health - GET", "description": "/health - GET", "operationId": "get-health", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "null", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "string" }, "entries": { "type": "object" } } }, "example": { "version": "string", "status": "string", "duration": "string", "entries": {} } } } }, "503": { "description": "null", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "string" }, "entries": { "type": "object" } } }, "example": { "version": "string", "status": "string", "duration": "string", "entries": {} } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/locks": { "post": { "summary": "Create new lock", "description": "Create new lock", "operationId": "create-new-lock", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockInputModel" }, "example": { "id": "string", "paths": [ "string" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockOutputModel" }, "example": { "publisher": "string", "id": "string", "paths": [ "string" ], "deleted": true, "createDate": {}, "lastUpdateDate": {}, "deleteDate": {}, "lastUpdateBy": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "GET locks", "description": "GET locks", "operationId": "get-locks", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "limit", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ArrayILockOutputModel" }, "example": [ { "publisher": "string", "id": "string", "paths": [ "string" ], "deleted": true, "createDate": {}, "lastUpdateDate": {}, "deleteDate": {}, "lastUpdateBy": "string" } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/locks/{id}": { "delete": { "summary": "DELETE a lock by id", "description": "DELETE a lock by id", "operationId": "delete-a-lock-by-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockOutputModel" }, "example": { "publisher": "string", "id": "string", "paths": [ "string" ], "deleted": true, "createDate": {}, "lastUpdateDate": {}, "deleteDate": {}, "lastUpdateBy": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "GET lock by id", "description": "GET lock by id", "operationId": "get-lock-by-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockOutputModel" }, "example": { "publisher": "string", "id": "string", "paths": [ "string" ], "deleted": true, "createDate": {}, "lastUpdateDate": {}, "deleteDate": {}, "lastUpdateBy": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Update a lock", "description": "Update a lock", "operationId": "update-a-lock", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockInputModel" }, "example": { "id": "string", "paths": [ "string" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ILockOutputModel" }, "example": { "publisher": "string", "id": "string", "paths": [ "string" ], "deleted": true, "createDate": {}, "lastUpdateDate": {}, "deleteDate": {}, "lastUpdateBy": "string" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/multitenant/configs/{id}": { "put": { "summary": "MultiTenant Config", "description": "Update a config item", "operationId": "664312bf3c579a3fc1c3fa7b", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Config input model. Id and references", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ChangeTenantConfigInputModel" }, "example": { "objectType": "store", "tenantId": "tenantId", "changes": [ { "action": "update", "name": "base-preparation", "version": "2000-01-04" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ITenantConfigOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/references": { "post": { "summary": "Create new reference", "description": "Create new reference", "operationId": "post-configuration-v1-references", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "reference-id to create custom-id for", "schema": { "type": "string" } }, { "name": "customId", "in": "query", "description": "the custom id to use for this particular item", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IReference" }, "example": { "objectsId": "string", "referenceId": "string", "publisher": "string", "id": "string", "version": 0, "parent": "string", "deleted": true, "createDate": {}, "lastUpdateBy": "string", "lastUpdateDate": {}, "deleteDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "Get reference from object-id", "description": "Get reference from object-id", "operationId": "get-configuration-v1-references", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "objects_id", "in": "query", "description": "specified object-id", "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Whether to include deleted references or not", "schema": { "type": "boolean", "default": false } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Page offset parameter", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IReference" }, "example": { "objectsId": "string", "referenceId": "string", "publisher": "string", "id": "string", "version": 0, "parent": "string", "deleted": true, "createDate": {}, "lastUpdateBy": "string", "lastUpdateDate": {}, "deleteDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/references/{id}": { "delete": { "summary": "Delete existing reference", "description": "Delete existing reference", "operationId": "delete-configuration-v1-references-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "reference-id to delete custom-id for", "required": true, "schema": { "type": "string" } }, { "name": "customId", "in": "query", "description": "the custom id to use for this particular item", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IReference" }, "example": { "objectsId": "string", "referenceId": "string", "publisher": "string", "id": "string", "version": 0, "parent": "string", "deleted": true, "createDate": {}, "lastUpdateBy": "string", "lastUpdateDate": {}, "deleteDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "Get the reference to actual object from specified custom-id", "description": "Get the reference to actual object from specified custom-id", "operationId": "get-configuration-v1-references-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "reference-id to find custom-id for", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Whether to include deleted references or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IReference" }, "example": { "objectsId": "string", "referenceId": "string", "publisher": "string", "id": "string", "version": 0, "parent": "string", "deleted": true, "createDate": {}, "lastUpdateBy": "string", "lastUpdateDate": {}, "deleteDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Update existing reference", "description": "Update existing reference", "operationId": "put-configuration-v1-references-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "reference-id to update custom-id for", "required": true, "schema": { "type": "string" } }, { "name": "customId", "in": "query", "description": "the custom id to use for this particular item", "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Whether to include deleted references or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IReference" }, "example": { "objectsId": "string", "referenceId": "string", "publisher": "string", "id": "string", "version": 0, "parent": "string", "deleted": true, "createDate": {}, "lastUpdateBy": "string", "lastUpdateDate": {}, "deleteDate": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/schemas": { "get": { "summary": "Get schema", "description": "Get schema", "operationId": "get-configuration-v1-schemas", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Specify point in time from which schema should be retrieved", "schema": { "type": "string", "format": "date-time" } }, { "name": "include_deleted", "in": "query", "description": "Specify if deleted schema should be retrieved", "schema": { "type": "boolean", "default": false } }, { "name": "type", "in": "query", "description": "Specify type of schema to retrieve", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ISchemaOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/types": { "get": { "summary": "GET a list of all DataTypes", "description": "GET a list of all DataTypes", "operationId": "get-configuration-v1-types", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether unpublished (private) types should be included. Default: false", "schema": { "type": "boolean", "default": false } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Offset for pagination", "schema": { "type": "string", "format": "date-time" } }, { "name": "complete", "in": "query", "description": "Complete datatype model", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ITypeMinimalOutputModel" } }, "example": [ { "publisher": "string", "id": "string", "version": "string", "baseType": "string", "availability": "Private" } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "post": { "summary": "POST a DataType", "description": "POST a DataType", "operationId": "post-configuration-v1-types", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The DataType to POST", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeInputModel" }, "example": { "typeReference": { "publisher": "string", "dataId": "string", "version": "string" }, "min": 0, "max": 0, "id": "string", "version": "string", "availability": "Private", "baseType": "String", "discriminator": { "properties": [ "string" ], "type": 0 } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/types/{id}": { "delete": { "summary": "DELETE a DataType with {id}", "description": "DELETE a DataType with {id}", "operationId": "delete-configuration-v1-types-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataType", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "GET DataType with {id}", "description": "GET DataType with {id}", "operationId": "get-configuration-v1-types-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataType", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include child DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether unpublished (private) types should be included. Default: false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "PUT a DataType with {id}", "description": "PUT a DataType with {id}", "operationId": "put-configuration-v1-types-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "The Id of the DataType", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted dataTypes", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The DataType to PUT", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeInputModel" }, "example": { "typeReference": { "publisher": "string", "dataId": "string", "version": "string" }, "min": 0, "max": 0, "id": "string", "version": "string", "availability": "Private", "baseType": "String", "discriminator": { "properties": [ "string" ], "type": 0 } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/types/{id}/internalversions/{version}": { "get": { "summary": "GET DataType with {id} and {version}", "description": "GET DataType with {id} and {version}", "operationId": "get-configuration-v1-types-id-internalversions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataType", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Format - int32. InternalVersion of DataType", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include child DataTypes", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/types/{id}/versions": { "get": { "summary": "GET a list[{take}] of DataType with {id}", "description": "GET a list[{take}] of DataType with {id}", "operationId": "get-configuration-v1-types-id-versions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataType", "required": true, "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Format - int32. Number of versions", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include relational datatypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether unpublished (private) types should be included. Default: false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/types/{id}/versions/{version}": { "get": { "summary": "GET DataType with {id} and {version}", "description": "GET DataType with {id} and {version}", "operationId": "get-configuration-v1-types-id-versions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataType", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "SemanticVersion of DataType", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_datatypes", "in": "query", "description": "Include child DataTypes", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether unpublished (private) types should be included. Default: false", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/validate/type/{typeRef}/version/{version}": { "post": { "summary": "Validate data on a type without saving it.", "description": "Validate data on a type without saving it.", "operationId": "post-configuration-v1-values-validate-type-typeref-version-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "typeRef", "in": "path", "description": "ReferenceId to type. 'publisher:id' or just 'id' if type is located on current tenant", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Semantic version of type to validate against", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Corresponding value to validate", "content": { "application/json": { "schema": { "type": "object", "description": "A JSON object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values": { "get": { "summary": "GET a list of all DataValues", "description": "GET a list of all DataValues", "operationId": "get-configuration-v1-values", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "include_data", "in": "query", "description": "Include {DATA} in DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether to check for published entities or not", "schema": { "type": "boolean", "default": false } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Pagination parameter", "schema": { "type": "string", "format": "date-time" } }, { "name": "complete", "in": "query", "description": "Complete entity", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "render_mode", "in": "query", "description": "Render mode is telling whether certain values should be presented as arrays or not", "schema": { "enum": [ "Basic", "Advanced" ], "type": "string", "default": "Advanced" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ValueMinimalOutputModel" } }, "example": [ { "id": "string", "version": 0, "availability": "Private", "refs": [ "string" ], "draft": true, "deleted": true, "lastUpdateDate": {} } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "post": { "summary": "POST a DataValue", "description": "POST a DataValue", "operationId": "post-configuration-v1-values", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "strategy", "in": "query", "description": "Tell service how to save values. Should only valid values be saved or is drafts allowed", "schema": { "enum": [ "ValidOnly", "DraftOnly", "DraftIfInvalid" ], "type": "string" } } ], "requestBody": { "description": "The DataValue to POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/dry-run": { "post": { "summary": "Dry-Run: POST a DataValue", "description": "Dry-Run: POST a DataValue", "operationId": "post-configuration-v1-values-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The DataValue to POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}": { "delete": { "summary": "DELETE all Data on Value with {id}", "description": "DELETE all Data on Value with {id}", "operationId": "delete-configuration-v1-values-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "include_data", "in": "query", "description": "Whether or not raw data is needed or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "get": { "summary": "GET DataValue with {id} and optional {date}", "description": "GET DataValue with {id} and optional {date}", "operationId": "get-configuration-v1-values-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Format - date-time (as date-time in RFC3339). DataValue at specific date", "schema": { "type": "string", "format": "date-time" } }, { "name": "include_data", "in": "query", "description": "Include {DATA} in DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether to check for published entities or not", "schema": { "type": "boolean", "default": false } }, { "name": "render_mode", "in": "query", "description": "Render mode is telling whether certain values should be presented as arrays", "schema": { "enum": [ "Basic", "Advanced" ], "type": "string", "default": "Advanced" } }, { "name": "overwrite_rendered", "in": "query", "description": "Whether to overwrite rendered value or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "patch": { "summary": "Patch a DataValue with {id}", "description": "Patch a DataValue with {id}", "operationId": "patch-configuration-v1-values-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "strategy", "in": "query", "description": "Tell service how to save values. Should only valid values be saved or is drafts allowed", "schema": { "enum": [ "ValidOnly", "DraftOnly", "DraftIfInvalid" ], "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Tell objects system to include deleted when updating", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The DataValue to Patch", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "POST a DataValue", "description": "POST a DataValue", "operationId": "put-configuration-v1-values-id", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "strategy", "in": "query", "description": "Tell service how to save values. Should only valid values be saved or is drafts allowed", "schema": { "enum": [ "ValidOnly", "DraftOnly", "DraftIfInvalid" ], "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Tell objects to include deleted stores", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The DataValue to POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}/dry-run": { "patch": { "summary": "Dry-Run: Patch a DataValue with {id}", "description": "Dry-Run: Patch a DataValue with {id}", "operationId": "patch-configuration-v1-values-id-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Tell objects system to include deleted when updating", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "The DataValue to Patch", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] }, "put": { "summary": "Dry-Run: POST a DataValue", "description": "Dry-Run: POST a DataValue", "operationId": "put-configuration-v1-values-id-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "" } } ], "requestBody": { "description": "The DataValue to POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}/part/{part}": { "delete": { "summary": "DELETE a DataValue with {id}", "description": "DELETE a DataValue with {id}", "operationId": "delete-configuration-v1-values-id-part-part", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "part", "in": "path", "description": "jsonPath to part do delete", "required": true, "schema": { "type": "string" } }, { "name": "include_data", "in": "query", "description": "include data for properties", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}/part/{part}/dry-run": { "delete": { "summary": "Dry-Run: DELETE a DataValue with {id}", "description": "Dry-Run: DELETE a DataValue with {id}", "operationId": "delete-configuration-v1-values-id-part-part-dry-run", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "part", "in": "path", "description": "jsonPath to part do delete", "required": true, "schema": { "type": "string" } }, { "name": "include_data", "in": "query", "description": "include data for properties", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}/versions": { "get": { "summary": "Get a list[{take}] of DataValue with {id}", "description": "Get a list[{take}] of DataValue with {id}", "operationId": "get-configuration-v1-values-id-versions", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "take", "in": "query", "description": "Format - int32. Number of versions", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "include_private", "in": "query", "description": "Whether to check for published entities or not", "schema": { "type": "boolean", "default": false } }, { "name": "include_drafts", "in": "query", "description": "Whether to include draft-versions or not", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } }, "example": [ {} ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/entities/{entity}/values/{id}/versions/{version}": { "get": { "summary": "GET DataValue with {id} and {version}", "description": "GET DataValue with {id} and {version}", "operationId": "get-configuration-v1-values-id-versions-version", "parameters": [ { "name": "entity", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "description": "Format - int32. Version of DataValue", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean", "default": false } }, { "name": "render_mode", "in": "query", "description": "Render mode is telling whether certain values should be presented as arrays", "schema": { "enum": [ "Basic", "Advanced" ], "type": "string", "default": "Advanced" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" } } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entity_ErrorInfo" } } } } }, "tags": [ "Entities" ] } }, "/orchestration/flows": { "post": { "summary": "Create a Flow", "description": "This creates a new flow.", "operationId": "CreateFlow", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The flow to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flowCreationDto" }, "examples": { "Create flow with manual identifiers": { "value": { "jobs": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "MANUAL", "identifiers": [ "21", "22", "23", "31", "32", "33" ] } } }, "Create flow with startProcedure job": { "value": { "jobs": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "NONE" } } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flow" }, "examples": { "Flow with manual start procedure": { "value": { "id": "id1", "tenantId": "fo", "jobIds": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "MANUAL", "identifiers": [ "21", "22", "23", "31", "32", "33" ] } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "List flows", "description": "This lists flows.", "operationId": "ListFlows", "parameters": [ { "name": "entity_type", "in": "query", "description": "The entityType for the flow", "schema": { "enum": [ "stores", "menus" ], "type": "string", "default": "stores" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_flow" } }, "example": [ { "id": "string", "tenantId": "string", "jobIds": [ "string" ], "entityType": "stores", "startProcedure": { "startProcedureType": "NONE", "identifiers": [ "string" ] } } ] } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/flows/{id}": { "delete": { "summary": "Delete a Flow", "description": "This deletes a flow.", "operationId": "DeleteFlows", "parameters": [ { "name": "id", "in": "path", "description": "The id of the flow", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flow" }, "examples": { "Flow with manual start procedure": { "value": { "id": "id1", "tenantId": "fo", "jobIds": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "MANUAL", "identifiers": [ "21", "22", "23", "31", "32", "33" ] } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "Get a Flow", "description": "This gets a flow.", "operationId": "GetFlow", "parameters": [ { "name": "id", "in": "path", "description": "The id of the flow", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flow" }, "examples": { "Flow with manual start procedure": { "value": { "id": "id1", "tenantId": "fo", "jobIds": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "MANUAL", "identifiers": [ "21", "22", "23", "31", "32", "33" ] } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "put": { "summary": "Update a Flow", "description": "This updates a flow.", "operationId": "UpdateFlows", "parameters": [ { "name": "id", "in": "path", "description": "The id of the flow", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The flow to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flowCreationDto" }, "examples": { "Create flow with manual identifiers": { "value": { "jobs": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "MANUAL", "identifiers": [ "21", "22", "23", "31", "32", "33" ] } } }, "Create flow with startProcedure job": { "value": { "jobs": [ "123", "234" ], "entityType": "stores", "startProcedure": { "startProcedureType": "NONE" } } } } } } }, "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_flow" }, "example": { "id": "string", "tenantId": "string", "jobIds": [ "string" ], "entityType": "stores", "startProcedure": { "startProcedureType": "NONE", "identifiers": [ "string" ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/flows/{id}/logs": { "get": { "summary": "List logs for flow", "description": "This provides logs for a specific flow", "operationId": "LogsFromFlows", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Flow", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_logEntry" } }, "examples": { "LogEntries example with error from start process job": { "value": [ { "id": "logentry1", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Start", "jobId": "fo-orch", "title": "Internal", "description": "Creating run from flow" }, "createdAt": "2023-02-14T12:50:20.0382862+00:00" }, { "id": "logentry2", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "StartProcess", "jobId": "startprocessjobid1", "title": "NONE", "description": "Running start procedure" }, "createdAt": "2023-02-14T12:50:20.0382919+00:00" }, { "id": "logentry3", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Error", "jobId": "startprocessjobid1", "title": "fo.job.error.type", "description": "Error message from job" }, "createdAt": "2023-02-14T12:50:20.0382928+00:00" } ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/jobs": { "post": { "summary": "Create a job", "description": "This creates a new job.", "operationId": "CreateJob", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The job to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_jobCreationDto" }, "examples": { "Job example with fo authentication": { "value": { "url": "https://example.com/get/stores", "description": "Integration with example tenant", "entityType": "stores", "configuration": { "reset_cache": "123", "include_optional": true }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_job" }, "examples": { "Job example with fo auth configuration": { "value": { "id": "id1", "tenantId": "fo", "url": "https://example.com/import?type=stores", "description": "Import store from tenant integration", "entityType": "stores", "configuration": { "optional_config": true, "other_config": "setting1" }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "List jobs", "description": "This lists jobs.", "operationId": "ListJobs", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_job" } }, "example": [ { "id": "string", "tenantId": "string", "url": "string", "description": "string", "entityType": "stores", "configuration": {}, "timeOut": { "ticks": 0, "days": 0, "hours": 0, "milliseconds": 0, "minutes": 0, "seconds": 0, "totalDays": 0, "totalHours": 0, "totalMilliseconds": 0, "totalMinutes": 0, "totalSeconds": 0 }, "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "username": "string", "password": "string", "scope": "string" } } ] } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/jobs/{id}": { "delete": { "summary": "Delete a job", "description": "This deletes a job.", "operationId": "DeleteJob", "parameters": [ { "name": "id", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_job" }, "examples": { "Job example with fo auth configuration": { "value": { "id": "id1", "tenantId": "fo", "url": "https://example.com/import?type=stores", "description": "Import store from tenant integration", "entityType": "stores", "configuration": { "optional_config": true, "other_config": "setting1" }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "Get a job", "description": "This gets a job.", "operationId": "GetJob", "parameters": [ { "name": "id", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_job" }, "examples": { "Job example with fo auth configuration": { "value": { "id": "id1", "tenantId": "fo", "url": "https://example.com/import?type=stores", "description": "Import store from tenant integration", "entityType": "stores", "configuration": { "optional_config": true, "other_config": "setting1" }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "put": { "summary": "Update a job", "description": "This updates a job.", "operationId": "UpdateJob", "parameters": [ { "name": "id", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The job to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_jobCreationDto" }, "examples": { "Job example with fo authentication": { "value": { "url": "https://example.com/get/stores", "description": "Integration with example tenant", "entityType": "stores", "configuration": { "reset_cache": "123", "include_optional": true }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } }, "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_job" }, "examples": { "Job example with fo auth configuration": { "value": { "id": "id1", "tenantId": "fo", "url": "https://example.com/import?type=stores", "description": "Import store from tenant integration", "entityType": "stores", "configuration": { "optional_config": true, "other_config": "setting1" }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/logs": { "get": { "summary": "List logs", "description": "This lists logs.", "operationId": "ListLogs", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_logEntry" } }, "examples": { "LogEntries example with error from start process job": { "value": [ { "id": "logentry1", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Start", "jobId": "fo-orch", "title": "Internal", "description": "Creating run from flow" }, "createdAt": "2023-02-14T12:50:20.0516571+00:00" }, { "id": "logentry2", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "StartProcess", "jobId": "startprocessjobid1", "title": "NONE", "description": "Running start procedure" }, "createdAt": "2023-02-14T12:50:20.0516605+00:00" }, { "id": "logentry3", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Error", "jobId": "startprocessjobid1", "title": "fo.job.error.type", "description": "Error message from job" }, "createdAt": "2023-02-14T12:50:20.0516612+00:00" } ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/logs/{id}": { "get": { "summary": "Get a log", "description": "This gets a log.", "operationId": "GetLog", "parameters": [ { "name": "id", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_logEntry" }, "examples": { "Progress status": { "value": { "id": "logentryid1", "tenantId": "fo", "flowId": "flowid1", "runId": "runid1", "logReport": { "logReportType": "Progress", "jobId": "jobid1", "title": "TRANSFERRING", "description": "Transferring stores to blob storage" }, "createdAt": "2023-02-14T12:50:20.048409+00:00" } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/reports/complete": { "post": { "summary": "Create a complete report", "description": "This creates a new complete report.", "operationId": "CreateCompleteReport", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The complete report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_completeReportCreationDto" }, "examples": { "Example": { "value": { "flowId": "flowid1", "jobId": "jobid1", "runId": "runid1", "data": { "21": { "references": [ "example:21" ], "dataSources": [ "exampleSystem" ], "route": "https://example.com/runid1/jobid1/21" }, "22": { "references": [ "example:33", "otherSystem:22" ], "dataSources": [ "exampleSystem", "otherSystem" ], "route": "https://example.com/runid1/jobid1/22" } } } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_completeReport" }, "examples": { "Example": { "value": { "flowId": "flowid1", "jobId": "jobid1", "runId": "runid1", "data": { "21": { "references": [ "example:21" ], "dataSources": [ "exampleSystem" ], "route": "https://example.com/runid1/jobid1/21" }, "22": { "references": [ "example:33", "otherSystem:22" ], "dataSources": [ "exampleSystem", "otherSystem" ], "route": "https://example.com/runid1/jobid1/22" } } } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/reports/error": { "post": { "summary": "Create a error report", "description": "This creates a new error report.", "operationId": "CreateErrorReport", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The error report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_errorReportCreationDto" }, "examples": { "Example": { "value": { "flowId": "flowid1", "jobId": "jobid1", "runId": "runid1", "error": { "code": "fo.example.error.code", "message": "Descriptive error text", "data": { "21": "Error with something", "22": "Error with something else" } } } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_errorReport" }, "examples": { "Example": { "value": { "flowId": "flowId1", "jobId": "jobid1", "runId": "runid1", "error": { "code": "fo.example.error.code", "message": "Descriptive error text", "data": { "21": "Error with something", "22": "Error with something else" } } } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/reports/progress": { "post": { "summary": "Create a progress report", "description": "This creates a new progress report.", "operationId": "CreateProgressReport", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The progress report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_progressReportCreationDto" }, "examples": { "progressReport": { "value": { "flowId": "flowid1", "jobId": "jobid1", "runId": "runid1", "status": "LOADING", "information": "more information about progress" } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_progressReport" }, "examples": { "progressReport": { "value": { "flowId": "flowid1", "jobId": "jobid1", "runId": "runid1", "status": "LOADING", "information": "more information about progress" } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/runs": { "post": { "summary": "Create a run from a flow", "description": "This creates a new run.", "operationId": "CreateRuns", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The run to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_runCreationDto" }, "examples": { "example 2": { "value": { "flowId": "flowid2", "position": 3 } }, "example 1": { "value": { "flowId": "flowid1" } }, "example 3": { "value": { "flowId": "flowid3", "startingIdentifiers": [ "21", "22", "23" ] } } } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_run" }, "examples": { "example 1": { "value": { "id": "runid1", "tenantId": "fo", "flowId": "flowid1", "createdAt": "2023-02-14T12:50:20.0613015+00:00", "status": "Active" } } } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "Get a list of runs", "description": "This returns available runs", "operationId": "ListRuns", "parameters": [ { "name": "flow_id", "in": "query", "description": "The id of the flow", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_run" } }, "examples": { "example 1": { "value": [ { "id": "runid1", "tenantId": "fo", "flowId": "flowid1", "createdAt": "2023-02-14T12:50:20.0590588+00:00", "status": "Active" }, { "id": "runid2", "tenantId": "fo", "flowId": "flowid1", "createdAt": "2023-02-14T12:50:20.0590607+00:00", "status": "Failed" }, { "id": "runid3", "tenantId": "fo", "flowId": "flowid2", "createdAt": "2023-02-14T12:50:20.0590614+00:00", "status": "Completed" } ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/runs/{id}/jobs/{jobId}/entities/{entityId}": { "post": { "summary": "Add entity data", "description": "This adds entity data that can be used by the next job", "operationId": "CreateEntities", "parameters": [ { "name": "id", "in": "path", "description": "The id of the run", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The id of the entity", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The entity", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "responses": { "201": { "description": "This returns the route to the entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_runEntityResponseDto" }, "example": { "url": "string" } } } } }, "tags": [ "Master Data Orchestrations" ] }, "get": { "summary": "Get entity data", "description": "This fetches a entity", "operationId": "GetEntities", "parameters": [ { "name": "id", "in": "path", "description": "The id of the run", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The id of the entity", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "201": { "description": "This returns the entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_runEntityDto" }, "example": { "data": {} } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/runs/{id}/jobs/{jobId}/entities/{entityId}/collection": { "post": { "summary": "Add entity data collection", "description": "This adds entity data as a batch that can be used by the next job", "operationId": "64116f3e00e3e238a0ec8170", "parameters": [ { "name": "id", "in": "path", "description": "The id of the run", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The id of the job", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "description": "The id of the entity", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The entity", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "responses": { "201": { "description": "This returns the route to the entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_runEntityResponseDto" }, "example": { "url": "string" } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/runs/{id}/jobs/{jobId}/logs": { "get": { "summary": "List logs for job in a specific run", "description": "This provides logs for a specific job and run", "operationId": "LogsForJob", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Run", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "description": "The id of the Job", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_logEntry" } }, "examples": { "LogEntries example with error from start process job": { "value": [ { "id": "logentry1", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Start", "jobId": "fo-orch", "title": "Internal", "description": "Creating run from flow" }, "createdAt": "2023-02-14T12:50:20.0726939+00:00" }, { "id": "logentry2", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "StartProcess", "jobId": "startprocessjobid1", "title": "NONE", "description": "Running start procedure" }, "createdAt": "2023-02-14T12:50:20.072698+00:00" }, { "id": "logentry3", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Error", "jobId": "startprocessjobid1", "title": "fo.job.error.type", "description": "Error message from job" }, "createdAt": "2023-02-14T12:50:20.0726989+00:00" } ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/runs/{id}/logs": { "get": { "summary": "List logs for run", "description": "This provides logs for a specific run", "operationId": "LogsRun", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Run", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_logEntry" } }, "examples": { "LogEntries example with error from start process job": { "value": [ { "id": "logentry1", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Start", "jobId": "fo-orch", "title": "Internal", "description": "Creating run from flow" }, "createdAt": "2023-02-14T12:50:20.0707567+00:00" }, { "id": "logentry2", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "StartProcess", "jobId": "startprocessjobid1", "title": "NONE", "description": "Running start procedure" }, "createdAt": "2023-02-14T12:50:20.070763+00:00" }, { "id": "logentry3", "tenantId": "fo", "flowId": "flow1", "runId": "run1", "logReport": { "logReportType": "Error", "jobId": "startprocessjobid1", "title": "fo.job.error.type", "description": "Error message from job" }, "createdAt": "2023-02-14T12:50:20.0707638+00:00" } ] } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/timer": { "post": { "summary": "Create a Timer", "description": "Create a specific timer", "operationId": "64244887204bd7b71f013665", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The flow to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "example": { "from": "string", "to": "string", "timesOfDay": [ "string" ], "flowId": "string", "startingIdentifiers": [ "string" ], "jobId": "string" } } } }, "responses": { "201": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "example": { "from": "string", "to": "string", "timesOfDay": [ "string" ], "flowId": "string", "startingIdentifiers": [ "string" ], "jobId": "string" } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/timer/{id}": { "delete": { "summary": "Delete a timer", "description": "Delete a specific timer", "operationId": "642442ff2f96931649e38649", "parameters": [ { "name": "id", "in": "path", "description": "The id of the timer", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "example": { "from": "string", "to": "string", "timesOfDay": [ "string" ], "flowId": "string", "startingIdentifiers": [ "string" ], "jobId": "string" } } } } }, "tags": [ "Master Data Orchestrations" ] }, "put": { "summary": "Update a timer", "description": "Update a specific timer", "operationId": "642440907de7be0620c18482", "parameters": [ { "name": "id", "in": "path", "description": "The id of the timer", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "requestBody": { "description": "The job to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "examples": { "Job example with fo authentication": { "value": { "url": "https://example.com/get/stores", "description": "Integration with example tenant", "entityType": "stores", "configuration": { "reset_cache": "123", "include_optional": true }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } }, "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "examples": { "Job example with fo auth configuration": { "value": { "id": "id1", "tenantId": "fo", "url": "https://example.com/import?type=stores", "description": "Import store from tenant integration", "entityType": "stores", "configuration": { "optional_config": true, "other_config": "setting1" }, "timeOut": "2023-02-14", "failOnTimeOut": true, "authenticationConfiguration": { "authenticationType": "FO", "scope": "fo:example" } } } } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/timers": { "get": { "summary": "List timers", "description": "List timers", "operationId": "64243f047ec5dd0a0671aba1", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MDOrchestration_timer" } }, "example": [ { "id": "string", "tenantId": "string", "jobIds": [ "string" ], "entityType": "stores", "startProcedure": { "startProcedureType": "NONE", "identifiers": [ "string" ] } } ] } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/orchestration/timers/{id}": { "get": { "summary": "Get a timer", "description": "Get a specific timer", "operationId": "64243ba57ac942e8a69c5021", "parameters": [ { "name": "id", "in": "path", "description": "The id of the flow from whom you want the configured timers.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "This returns the response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MDOrchestration_timer" }, "example": { "from": "string", "to": "string", "timesOfDay": [ "string" ], "flowId": "string", "startingIdentifiers": [ "string" ], "jobId": "string" } } } } }, "tags": [ "Master Data Orchestrations" ] } }, "/frontend/plugins": { "delete": { "tags": [ "Frontend Plugins" ], "summary": "Deletes a plugin", "description": "Deletes a plugin with matching name and version", "operationId": "delete-plugins-name-name-version-version", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "minimum": 3, "type": "string" } }, { "name": "version", "in": "query", "required": true, "schema": { "type": "string", "example": "1.0.0" } } ], "responses": { "200": { "description": "Successfully deleted plugin", "content": { "application/json": {} } }, "400": { "description": "Bad request, missing or invalid parameters or plugin matching name and version not found" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to delete plugins" } } }, "get": { "tags": [ "Frontend Plugins" ], "summary": "Lists plugins", "description": "Lists plugins for tenant. Global plugins are prefixed with fo/", "operationId": "get-plugins", "parameters": [ { "name": "excludeGlobalPlugins", "in": "query", "description": "Exclude global plugins", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Successfully returned list of plugins", "content": { "application/json": { "example": { "plugins": [ { "name": "plugin1", "config": { "key": "value" } } ] } } } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to list plugins" } } }, "post": { "tags": [ "Frontend Plugins" ], "summary": "Uploads a plugin", "description": "Uploads plugin, overwriting any existing plugin with the same name and version", "operationId": "post-plugins-name-name-version-version", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Format - semver.", "required": true, "schema": { "type": "string", "format": "semver", "example": "1.0.0" } } ], "requestBody": { "description": "Plugin code", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "default": { "value": null } } } } }, "responses": { "200": { "description": "Successfully uploaded plugin", "content": { "application/json": {} } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to upload plugin" } } } }, "/frontend/plugins/config": { "post": { "tags": [ "Frontend Plugins" ], "summary": "Creates plugin config", "description": "Creates plugin config. Prefix plugin name with fo/ for global plugins. Setting plugin config activates the plugin.", "operationId": "post-plugins-config", "requestBody": { "description": "Plugin config", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_PluginConfig" }, "example": { "name": "string", "version": "string", "config": {}, "channels": [ "kiosk" ], "countryCodes": [ "string" ], "consentLevels": [ "standard" ], "appTrackingConsent": true, "dependentOn": [ "string" ], "paused": true, "allowedDataUrls": [ "string" ], "removeAt": "string", "esm": true } } } }, "responses": { "201": { "description": "Successfully created new plugin config", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Result text" }, "pluginConfig": { "$ref": "#/components/schemas/FrontendPlugin_PluginConfig" } } }, "example": { "message": "string", "pluginConfig": { "name": "string", "version": "string", "config": {}, "channels": [ "kiosk" ], "countryCodes": [ "string" ], "consentLevels": [ "standard" ], "appTrackingConsent": true, "dependentOn": [ "string" ], "paused": true, "allowedDataUrls": [ "string" ], "removeAt": "string", "esm": true } } } } }, "400": { "description": "Bad request, missing or invalid parameters, plugin matching name and version not found or invalid plugin config" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to set plugin config" } } }, "get": { "tags": [ "Frontend Plugins" ], "summary": "Gets plugin config", "description": "Gets plugin config for the tenant. Global plugins are prefixed with fo/", "operationId": "get-plugins-config", "responses": { "200": { "description": "Successfully returned plugin config", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrontendPlugin_PluginConfig" } }, "example": [ { "name": "myPlugin", "version": "1.0.0", "config": { "key": "value" } } ] } } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to list plugins" } } } }, "/frontend/plugins/manifest": { "get": { "tags": [ "Frontend Plugins" ], "summary": "Gets plugin manifest", "description": "Gets plugin manifest for plugin", "operationId": "get-plugins-manifest-name-name", "parameters": [ { "name": "name", "in": "query", "description": "Plugin name, prefix with fo/ for global plugins", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Plugin manifest", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrontendPlugin_PluginManifest" } }, "example": { "esm": true, "parameters": [] } } } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to list plugins" }, "404": { "description": "Plugin manifest not found" } } }, "post": { "tags": [ "Frontend Plugins" ], "summary": "Uploads plugin manifest", "description": "Uploads plugin manifest for tenant specific plugin, overwriting any existing plugin manifest", "operationId": "post-plugins-manifest-name-name", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Plugin manifest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_PluginManifest" }, "example": { "version": "string", "description": "string", "esm": true, "parameters": [ {} ], "hidden": true, "deprecated": true } } } }, "responses": { "200": { "description": "Successfully uploaded plugin manifest", "content": { "application/json": {} } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to upload plugin manifest" } } } }, "/frontend/plugins/{id}/config": { "delete": { "tags": [ "Frontend Plugins" ], "summary": "Deletes plugin config", "description": "Deletes plugin config with id", "operationId": "delete-plugins-id-config", "parameters": [ { "name": "id", "in": "path", "description": "Plugin id is required to specify which plugin config to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully deleted plugin config", "content": { "application/json": {} } }, "400": { "description": "Bad request, missing or invalid parameters" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to set plugin config" } } }, "put": { "tags": [ "Frontend Plugins" ], "summary": "Sets plugin config", "description": "Updates plugin config, overwriting existing config with specified id", "operationId": "put-plugins-id-config", "parameters": [ { "name": "id", "in": "path", "description": "Plugin id is required to specify which plugin config to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Plugin config", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_PluginConfig" }, "example": { "name": "string", "version": "string", "config": {}, "channels": [ "kiosk" ], "countryCodes": [ "string" ], "consentLevels": [ "standard" ], "appTrackingConsent": true, "dependentOn": [ "string" ], "paused": true, "allowedDataUrls": [ "string" ], "removeAt": "string", "esm": true } } } }, "responses": { "200": { "description": "Successfully set plugin config", "content": { "application/json": {} } }, "400": { "description": "Bad request, missing or invalid parameters, plugin matching name and version not found or invalid plugin config" }, "401": { "description": "Unauthorized, missing or invalid token" }, "403": { "description": "Forbidden, token does not have permission to set plugin config" } } } }, "/frontend/promotions/banner": { "get": { "tags": [ "PromotionsManager" ], "summary": "Get Banners Data", "operationId": "get-banners-data", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Get_Banners_Data_Response" }, "example": { "current": { "promotions": [ { "id": "string", "displayName": "string", "image": "string", "altText": "string", "tenantId": "string" } ], "groups": [ { "id": "string", "displayName": "string", "promotionGroups": [ { "id": "string", "categoryIds": [ 0 ], "promotionItems": [ { "id": "string" } ] } ], "tenantId": "string" } ] }, "published": { "promotions": [ { "id": "string", "displayName": "string", "image": "string", "altText": "string", "tenantId": "string" } ], "groups": [ { "id": "string", "displayName": "string", "promotionGroups": [ { "id": "string", "categoryIds": [ 0 ], "promotionItems": [ { "id": "string" } ] } ], "tenantId": "string" } ] }, "lastPublishedAt": "string" } } } }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/banner/groups": { "post": { "tags": [ "PromotionsManager" ], "summary": "Create Banner group", "operationId": "create-banner-group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Banner_Group_Creation_Request" }, "example": { "displayName": "string", "selector": { "cultureCodes": [ "string" ], "storeIds": [ 0 ], "countryCodes": [ "string" ] }, "promotionGroups": [ { "id": "string", "categoryIds": [ 0 ], "promotionItems": [ { "id": "string" } ] } ] } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } }, "put": { "tags": [ "PromotionsManager" ], "summary": "Update Banner Group", "operationId": "update-banner-group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Banner_Group_Update_Request" }, "example": { "id": "string", "displayName": "string", "selector": { "cultureCodes": [ "string" ], "storeIds": [ 0 ], "countryCodes": [ "string" ] }, "promotionGroups": [ { "id": "string", "categoryIds": [ 0 ], "promotionItems": [ { "id": "string" } ] } ] } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/banner/groups/{id}": { "delete": { "tags": [ "PromotionsManager" ], "summary": "Delete Banner Group", "operationId": "promotions-manager-delete-banner-group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } } } }, "/frontend/promotions/banner/promotions": { "post": { "tags": [ "PromotionsManager" ], "summary": "Create Banner Promotion", "operationId": "create-banner-promotion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Banner_Promotion_Creation_Request" }, "example": { "displayName": "string", "image": "string", "altText": "string", "tags": [ "string" ], "action": { "type": "string", "params": { "categoryId": 0 } } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } }, "put": { "tags": [ "PromotionsManager" ], "summary": "Update Banner Promotion", "operationId": "update-banner-promotion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Banner_Promotion_Update_Request" }, "example": { "id": "string", "displayName": "string", "image": "string", "altText": "string", "tags": [ "string" ], "action": { "type": "string", "params": { "categoryId": 0 } } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/banner/promotions/{id}": { "delete": { "tags": [ "PromotionsManager" ], "summary": "Delete Banner Promotion", "operationId": "promotions-manager-delete-banner-promotion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "404": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/banner/publish": { "post": { "tags": [ "PromotionsManager" ], "summary": "Publish Banner Changes", "operationId": "publish-banner-changes", "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/file-upload": { "post": { "tags": [ "PromotionsManager" ], "summary": "Upload Promotion File", "operationId": "upload-promotion-file", "requestBody": { "content": { "multipart/form-data": {} } }, "responses": { "200": { "description": "" }, "401": { "description": "" }, "400": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero": { "get": { "tags": [ "PromotionsManager" ], "summary": "Get Slideshows Data", "operationId": "get-slideshows-data", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Get_Slideshows_Data_Response" }, "example": { "current": { "promotions": [ { "id": "string", "displayName": "string", "portrait": "string", "portraitAltText": "string", "landscape": "string", "landscapeAltText": "string", "tenantId": "string", "themeColor": "string", "tags": [ "string" ], "action": { "type": "string", "url": "string" }, "durationOverride": 0 } ], "slideshows": [ { "id": "string", "displayName": "string", "slides": [ { "promotionId": "string" } ], "tenantId": "string", "slideInterval": 0, "selector": { "countryCodes": [ "string" ] } } ] }, "published": { "promotions": [ { "id": "string", "displayName": "string", "portrait": "string", "portraitAltText": "string", "landscape": "string", "landscapeAltText": "string", "tenantId": "string", "themeColor": "string", "tags": [ "string" ], "action": { "type": "string", "url": "string" }, "durationOverride": 0 } ], "slideshows": [ { "id": "string", "displayName": "string", "slides": [ { "promotionId": "string" } ], "tenantId": "string", "slideInterval": 0, "selector": { "countryCodes": [ "string" ] } } ] }, "lastPublishedAt": "string" } } } }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero/promotions": { "post": { "tags": [ "PromotionsManager" ], "summary": "Create Hero Promotion", "operationId": "create-hero-promotion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Hero_Promotion_Creation_Request" }, "example": { "displayName": "string", "portrait": "string", "portraitAltText": "string", "landscape": "string", "landscapeAltText": "string", "themeColor": "string", "tags": [ "string" ], "action": { "type": "string", "params": { "categoryId": 0, "menuType": "string", "code": "string", "productAdd": "string" } } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } }, "put": { "tags": [ "PromotionsManager" ], "summary": "Update Hero Promotion", "operationId": "update-hero-promotion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Hero_Promotion_Update_Request" }, "example": { "id": "string", "displayName": "string", "portrait": "string", "portraitAltText": "string", "landscape": "string", "landscapeAltText": "string", "themeColor": "string", "tags": [ "string" ], "action": { "type": "string", "params": { "categoryId": 0, "menuType": "string", "code": "string", "productAdd": "string" } } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero/promotions/{id}": { "delete": { "tags": [ "PromotionsManager" ], "summary": "Delete Hero Promotion", "operationId": "promotions-manager-delete-hero-promotion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero/slideshows": { "post": { "tags": [ "PromotionsManager" ], "summary": "Create Slideshow", "operationId": "create-slideshow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Slideshow_Creation_Request" }, "example": { "displayName": "string", "slides": [ { "promotionId": "string", "periodConstraints": {} } ], "slideInterval": 0, "selector": { "channel": "string", "storeIds": [ 0 ], "cultureCodes": [ "string" ], "countryCodes": [ "string" ] } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } }, "put": { "tags": [ "PromotionsManager" ], "summary": "Update Slideshow", "operationId": "update-slideshow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Slideshow_Update_Request" }, "example": { "id": "string", "displayName": "string", "slides": [ { "promotionId": "string", "periodConstraints": {} } ], "slideInterval": 0, "selector": { "channel": "string", "storeIds": [ 0 ], "cultureCodes": [ "string" ], "countryCodes": [ "string" ] } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero/slideshows/publish": { "post": { "tags": [ "PromotionsManager" ], "summary": "Publish Hero Changes", "operationId": "publish-hero-changes", "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/promotions/hero/slideshows/{id}": { "delete": { "tags": [ "PromotionsManager" ], "summary": "Delete Slideshow", "operationId": "promotions-manager-delete-slideshow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } } } }, "/frontend/touchpoint/sessions": { "get": { "summary": "List Touchpoint Sessions", "operationId": "list-touchpoint-sessions", "parameters": [ { "name": "storeId", "in": "query", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FrontendPlugin_Touchpoint_Session" } }, "example": [ { "sessionId": "string", "tenantId": "string", "storeId": "string", "countryCode": "string", "status": "string", "owner": { "userId": "string", "name": "string" }, "observers": [ { "userId": "string", "name": "string", "imageSrc": "string" } ], "device": { "isAuthenticated": true, "deviceId": "string" }, "orderId": "string", "createdAt": "string", "alerts": [ { "type": "string", "message": "string", "timestamp": "string" } ] } ] } } }, "401": { "description": "" }, "500": { "description": "" }, "400": { "description": "" } }, "tags": [ "Frontend Plugins" ] } }, "/frontend/touchpoint/sessions/{sessionId}": { "get": { "summary": "Get Touchpoint Session", "operationId": "get-touchpoint-session", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrontendPlugin_Touchpoint_Session_GET_Success" }, "example": { "sessionId": "string", "tenantId": "string", "storeId": "string", "countryCode": "string", "status": "string", "owner": { "userId": "string", "name": "string" }, "observers": [ { "userId": "string", "name": "string", "imageSrc": "string" } ], "device": { "isAuthenticated": true, "deviceId": "string" }, "orderId": "string", "createdAt": "string", "alerts": [ { "type": "string", "message": "string", "timestamp": "string" } ] } } } }, "400": { "description": "" }, "401": { "description": "" }, "500": { "description": "" } }, "tags": [ "Frontend Plugins" ] } }, "/payment-providers/{id}/events": { "post": { "summary": "External Payment Provider Events", "description": "This endpoint is called to report the outcome of each operation", "operationId": "post-events", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "enum": [ "external" ], "type": "string", "default": "external" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationCancelled" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationSucceeded" } ] }, "example": { "type": "payment.external.transaction.registration_succeeded.v1", "data": { "currency": "EUR", "amount": 1000, "merchantId": "example-merchant-id", "operationId": "419a333c-e6e6-4477-98de-d5916d8f47fb", "deviceId": "example-device-id" }, "specversion": "1.0", "id": "2b53022a-e88e-44b1-acca-72e9af75d0cb", "source": "https://partner.example.com/v1/payments", "time": "2024-01-15T10:30:05+00:00", "subject": "transaction/3cb0a664-b18f-4330-bd38-796f185b8d6e", "datacontenttype": "application/json" } }, "text/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationCancelled" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationSucceeded" } ] }, "example": { "type": "payment.external.transaction.registration_succeeded.v1", "data": { "currency": "EUR", "amount": 1000, "merchantId": "example-merchant-id", "operationId": "419a333c-e6e6-4477-98de-d5916d8f47fb", "deviceId": "example-device-id" }, "specversion": "1.0", "id": "2b53022a-e88e-44b1-acca-72e9af75d0cb", "source": "https://partner.example.com/v1/payments", "time": "2024-01-15T10:30:05+00:00", "subject": "transaction/3cb0a664-b18f-4330-bd38-796f185b8d6e", "datacontenttype": "application/json" } }, "application/*+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureSucceeded" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationCancelled" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationFailed" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationSucceeded" } ] }, "example": { "type": "payment.external.transaction.registration_succeeded.v1", "data": { "currency": "EUR", "amount": 1000, "merchantId": "example-merchant-id", "operationId": "419a333c-e6e6-4477-98de-d5916d8f47fb", "deviceId": "example-device-id" }, "specversion": "1.0", "id": "2b53022a-e88e-44b1-acca-72e9af75d0cb", "source": "https://partner.example.com/v1/payments", "time": "2024-01-15T10:30:05+00:00", "subject": "transaction/3cb0a664-b18f-4330-bd38-796f185b8d6e", "datacontenttype": "application/json" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "examples": { "Missing required field": { "summary": "The request omits a field that must be present.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The Example field is required.", "target": "example" } ] } }, "Missing field required for resolving type": { "summary": "The request omits the type discriminator field.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "Missing required property 'type', type cannot be resolved", "target": "type" } ] } }, "Invalid field value": { "summary": "The request contains a field value that violates the validation rules.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Amount must be between 1 and 9.223372036854776E+18.", "target": "data.amount" } ] } }, "Invalid string length": { "summary": "The request contains a string field that does not meet the length requirements.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Currency must be a string with a minimum length of 3 and a maximum length of 3.", "target": "data.currency" } ] } } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "examples": { "Missing required field": { "summary": "The request omits a field that must be present.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The Example field is required.", "target": "example" } ] } }, "Missing field required for resolving type": { "summary": "The request omits the type discriminator field.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "Missing required property 'type', type cannot be resolved", "target": "type" } ] } }, "Invalid field value": { "summary": "The request contains a field value that violates the validation rules.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Amount must be between 1 and 9.223372036854776E+18.", "target": "data.amount" } ] } }, "Invalid string length": { "summary": "The request contains a string field that does not meet the length requirements.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Currency must be a string with a minimum length of 3 and a maximum length of 3.", "target": "data.currency" } ] } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "examples": { "Missing required field": { "summary": "The request omits a field that must be present.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The Example field is required.", "target": "example" } ] } }, "Missing field required for resolving type": { "summary": "The request omits the type discriminator field.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "Missing required property 'type', type cannot be resolved", "target": "type" } ] } }, "Invalid field value": { "summary": "The request contains a field value that violates the validation rules.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Amount must be between 1 and 9.223372036854776E+18.", "target": "data.amount" } ] } }, "Invalid string length": { "summary": "The request contains a string field that does not meet the length requirements.", "value": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#validation-error", "title": "Request validation failed.", "status": 400, "detail": "One or more fields failed validation.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [ { "code": "validation.error", "detail": "The field Currency must be a string with a minimum length of 3 and a maximum length of 3.", "target": "data.currency" } ] } } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "408": { "description": "Request Timeout" }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#rate-limit-exceeded", "title": "Rate limit exceeded.", "status": 429, "detail": "Too many requests were sent in a given amount of time. Retry later.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#rate-limit-exceeded", "title": "Rate limit exceeded.", "status": 429, "detail": "Too many requests were sent in a given amount of time. Retry later.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#rate-limit-exceeded", "title": "Rate limit exceeded.", "status": 429, "detail": "Too many requests were sent in a given amount of time. Retry later.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#internal-server-error", "title": "An unexpected error occurred.", "status": 500, "detail": "The server encountered an unexpected condition and could not complete the request.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#internal-server-error", "title": "An unexpected error occurred.", "status": 500, "detail": "The server encountered an unexpected condition and could not complete the request.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorResponse" }, "example": { "type": "https://developer.futureordering.com/docs/external-payment-provider/error-responses#internal-server-error", "title": "An unexpected error occurred.", "status": 500, "detail": "The server encountered an unexpected condition and could not complete the request.", "instance": "/v1/payments/3fa85f64-5717-4562-b3fc-2c963f66afa6", "errors": [] } } } } }, "tags": [ "Payment", "Custom Payment Provider" ] } }, "/orders/events/": { "get": { "summary": "Get order events", "description": "Get order events", "operationId": "get-order-events", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "null" } }, "tags": [ "Orders" ] } }, "/orders/register": { "post": { "summary": "Register Order", "description": "Registers an order in the Future Ordering system that has already been placed in a POS system.", "operationId": "register-order", "parameters": [ { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } }, { "name": "Request-Id", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_RegisterOrderRequest" } } } }, "responses": { "202": { "description": "Returns OrderId for the registered order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_RegisterOrderResponse" }, "example": { "orderId": "123" } } } }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "500": { "description": "Server Error" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}": { "get": { "summary": "Get order with order-id", "description": "Returns the Order identified by passing the order-id in the url.", "operationId": "getlateststatefororder", "parameters": [ { "name": "order-id", "in": "path", "description": "Used to identify which order to fetch.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "Get order by order-id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" }, "example": { "orderTypeId": "takeAway", "salesChannel": { "webClientVersion": "", "type": "kiosk", "userAgentString": "", "deviceId": "", "operatingSystem": "" }, "collectionDetails": { "type": "pickup" }, "userId": "79130413-1862-447b-91ca-3d8e8908d268", "payments": [], "items": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7286", "title": "Meal", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7285", "title": "Burger", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7284", "title": "Burger", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7034", "title": "Add", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "1cf4a855-96cc-4355-85c2-f3b9ebb81655", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "1cf4a855-96cc-4355-85c2-f3b9ebb81655.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7035", "title": "Remove", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "f633f457-a233-4244-b741-df37e429694e", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "f633f457-a233-4244-b741-df37e429694e.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7006", "title": "Change", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7001", "title": "Bread", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "64253adb-cf23-4fe6-9c23-893592c81c82", "unitIds": { "328bc913-dbbe-4ef1-9dd6-862529b97cd8.0": [ "64253adb-cf23-4fe6-9c23-893592c81c82.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "328bc913-dbbe-4ef1-9dd6-862529b97cd8", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "328bc913-dbbe-4ef1-9dd6-862529b97cd8.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11613", "title": "Change dressing", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11609", "title": "Original", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "edc873f3-44b8-4d8a-81a5-493c79c4a486", "unitIds": { "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e.0": [ "edc873f3-44b8-4d8a-81a5-493c79c4a486.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "4bd86e59-4c88-4995-ac3a-576c2455ed58", "unitIds": { "3b96c56c-13d6-4cb8-9bd5-5303e9341691.0": [ "4bd86e59-4c88-4995-ac3a-576c2455ed58.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "3b96c56c-13d6-4cb8-9bd5-5303e9341691", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "3b96c56c-13d6-4cb8-9bd5-5303e9341691.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7200", "title": "Change side", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7206", "title": "Crispy fries", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7207", "title": "ConFries2_StdMedFries", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7220", "title": "Fries, medium", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "debbe286-962c-4711-907b-a3253703e46e", "unitIds": { "904d0421-1d63-4b80-a69a-b070e5489389.0": [ "debbe286-962c-4711-907b-a3253703e46e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "904d0421-1d63-4b80-a69a-b070e5489389", "unitIds": { "6d0e2beb-eaaa-415d-a199-d27862e6b368.0": [ "904d0421-1d63-4b80-a69a-b070e5489389.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "6d0e2beb-eaaa-415d-a199-d27862e6b368", "unitIds": { "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455.0": [ "6d0e2beb-eaaa-415d-a199-d27862e6b368.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7127", "title": "Ändra dryck?", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11214", "title": "Coca-Cola", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11215", "title": "ConBev2_StdMedCocaCola", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11241", "title": "Coca-Cola, medium", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "a0947f47-6485-4836-93ea-d77b91a6567e", "unitIds": { "581454c0-d8c8-47e7-9421-45dd9b78bdfa.0": [ "a0947f47-6485-4836-93ea-d77b91a6567e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "581454c0-d8c8-47e7-9421-45dd9b78bdfa", "unitIds": { "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8.0": [ "581454c0-d8c8-47e7-9421-45dd9b78bdfa.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8", "unitIds": { "3babc9aa-f531-4d68-9f83-5f960c891d93.0": [ "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "3babc9aa-f531-4d68-9f83-5f960c891d93", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "3babc9aa-f531-4d68-9f83-5f960c891d93.0" ] } } ], "price": { "amount": 8200, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "238ae5c7-0e68-4558-8aa0-827a69f93b7d", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" ] } } ], "discounts": [ { "id": "e21801ef-06be-4053-a0bb-eda9eb1f6bdf", "createDate": "2024-06-05T07:43:47+00:00", "lastModified": "2024-06-05T07:43:47+00:00", "dealId": "string", "title": "string", "amounts": [ { "amount": 100, "vat": [ { "type": "string", "percent": 0 } ], "discountedItemId": "238ae5c7-0e68-4558-8aa0-827a69f93b7d", "discountedItemUnitId": "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" } ], "postVat": true, "relatedItemIds": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d" ], "relatedItemUnitIds": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" ] } ], "currencyIsoCode": "SEK", "currencyDecimalDigits": 2, "mainEventsHistory": [ "Created" ], "storeDetails": { "storeId": null, "tzdbTimeZoneId": "Europe/Paris", "countryIsoCode": "SE", "currencyDecimalDigits": 2 }, "readyTime": { "desired": "2023-10-24T06:20:16+00:00" }, "versionId": "3", "orderId": "AsAVUEr28xh", "storeId": "335", "createDate": "2024-06-05T07:43:04+00:00", "orderRefsDict": {}, "lastModified": "2024-06-05T07:45:02+00:00", "links": {}, "cultureCode": "sv-SE", "discountTotal": -100, "total": 8100, "subtotal": 7232 } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Order not found." } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/abort": { "post": { "summary": "Order abort", "description": "Order abort", "operationId": "67634001b3c2271e2494a023", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_OrderPosDataFailure" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/cancel-by-customer/disallow": { "post": { "summary": "Cancel by customer disallow", "description": "Set cancel by customer to disallow - i.e. no longer possible for customer to cancel the order", "operationId": "640598ea970b09c89af9a74b", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } }, { "name": "Content-Type", "in": "header", "required": true, "schema": { "enum": [ "application/json" ], "type": "string", "default": "application/json" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/collection-details": { "post": { "summary": "Set Collection Details", "description": "Set collection details on order", "operationId": "set-collection-details", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Content-Type", "in": "header", "schema": { "enum": [ "" ], "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_CollectionDetailsPickupLockerRequest" }, "example": { "collectionDetails": { "type": "pickupLocker", "pincode": "string" } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" }, "405": { "description": "Not possible to make this change on the order based on the state of the order. " } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/deals": { "post": { "tags": [ "Deals" ], "summary": "Creates a deal for order", "description": "Creates a deal for order", "operationId": "creates-a-deal-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_CreateDealCommand" }, "example": { "visibility": "notShown", "orderVersionId": "string", "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "description": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "name": "string", "key": "string", "code": "string", "discounts": [ { "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "createDate": "string", "relatedItemIds": [ "string" ], "relatedItemUnitIds": [ "string" ], "dealId": "string", "amounts": [ { "discountedItemId": "string", "discountedItemUnitId": "string", "amount": 0, "vat": [ { "type": "string", "percent": 0 } ] } ], "mappingDetails": { "someId": "123", "myInfo": { "foo": "bar", "baz": "qux" } } } ], "images": {} } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_CreateDealResult" }, "example": { "statusCode": "successful", "dealId": "2e91e25e-404f-4881-9d8a-9fffd4799446", "message": "Deal Created!", "innerCode": "2e91e25e-404f-4881-9d8a-9fffd4799446", "successful": true, "outerCode": 200 } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "409": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } }, "get": { "tags": [ "Deals" ], "summary": "Fetches all reserved deals filtered by query parameters", "description": "Fetches all reserved deals filtered by query parameters", "operationId": "gets-all-reserved-deals-filtered-by-query-parameters", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Filter deals only for a specific key", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_FetchDealsForOrder" }, "example": { "deals": [ { "dealId": "string", "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "description": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "name": "string", "key": "string", "images": {}, "orderVersionId": "string", "createDate": "string", "visibility": "notShown", "id": "string", "code": "string", "discounts": [ { "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "createDate": "string", "relatedItemIds": [ "string" ], "relatedItemUnitIds": [ "string" ], "dealId": "string", "amounts": [ { "discountedItemId": "string", "discountedItemUnitId": "string", "amount": 0, "vat": [ { "type": "string", "percent": 0 } ] } ], "mappingDetails": { "someId": "123", "myInfo": { "foo": "bar", "baz": "qux" } } } ], "orderId": "string", "status": "created", "isReserved": true, "isFulfilled": true, "isCaptured": true, "isAnnulled": true, "isRefunded": true } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } }, "patch": { "tags": [ "Deals" ], "summary": "Update deals for order", "description": "Update deals for order", "operationId": "update-deals-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Order_OrderDealPatchRequest" } }, "example": { "a99c0700-c88a-4203-a57d-bfe8b77f137f": { "code": "345634", "discounts": [ { "title": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "createDate": "2024-05-23T07:05:09+00:00", "relatedItemIds": [ "b2523f1d-5464-4ac9-9f28-927706d0efba" ], "relatedItemUnitIds": [ "b2523f1d-5464-4ac9-9f28-927706d0efba.0" ], "dealId": "dealId123", "amounts": [ { "discountedItemId": "b2523f1d-5464-4ac9-9f28-927706d0efba", "discountedItemUnitId": "b2523f1d-5464-4ac9-9f28-927706d0efba.0", "amount": 1000, "vat": [ { "type": "12.5%", "percent": 12.5 } ] } ], "mappingDetails": { "someId": "123", "myInfo": { "foo": "bar", "baz": "qux" } } } ], "isReserved": true, "isFulfilled": true, "isCaptured": false, "isAnnulled": false, "title": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "description": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "name": "display name", "key": "key for integrating system", "images": null, "orderVersionId": "13" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_DealPatchResponse" }, "example": { "statusCode": "successful", "message": "Patched", "innerCode": null, "successful": true, "outerCode": 200 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/deals/{deal-id}": { "get": { "tags": [ "Deals" ], "summary": "Fetch a deal for order", "description": "Fetch a deal for order", "operationId": "get-a-deal-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_OrderDeal" }, "example": { "dealId": "string", "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "description": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "name": "string", "key": "string", "images": {}, "orderVersionId": "string", "createDate": "string", "visibility": "notShown", "id": "string", "code": "string", "discounts": [ { "title": { "translations": { "default": "default translation", "en-GB": "British English translation" } }, "createDate": "string", "relatedItemIds": [ "string" ], "relatedItemUnitIds": [ "string" ], "dealId": "string", "amounts": [ { "discountedItemId": "string", "discountedItemUnitId": "string", "amount": 0, "vat": [ { "type": "string", "percent": 0 } ] } ], "mappingDetails": { "externalDiscountId": "123", "myInfo": { "foo": "bar", "baz": "qux" } } } ], "orderId": "string", "status": "created", "isReserved": true, "isFulfilled": true, "isCaptured": true, "isAnnulled": true, "isRefunded": true } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } }, "patch": { "tags": [ "Deals" ], "summary": "Update deal for order", "description": "Update deal for order", "operationId": "update-deal-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Order_DealPatchRequest" }, "example": { "code": "my-gift-card", "discounts": [ { "title": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "createDate": "2024-05-23T07:05:09+00:00", "relatedItemIds": [ "b2523f1d-5464-4ac9-9f28-927706d0efba" ], "relatedItemUnitIds": [ "b2523f1d-5464-4ac9-9f28-927706d0efba.0" ], "dealId": "", "amounts": [ { "discountedItemId": "b2523f1d-5464-4ac9-9f28-927706d0efba", "discountedItemUnitId": "b2523f1d-5464-4ac9-9f28-927706d0efba.0", "amount": 0, "vat": [ { "type": "2024-12-05", "percent": 12.5 } ] } ], "mappingDetails": { "externalDiscountId": "123" } } ], "isReserved": true, "isFulfilled": true, "isCaptured": false, "isAnnulled": false, "title": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "description": { "translations": { "en-GB": "British English translation", "default": "default translation" } }, "name": "display name", "key": "key for integrating system", "images": null, "orderVersionId": "13" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_DealPatchResponse" }, "example": { "statusCode": "successful", "message": "Patched", "innerCode": null, "successful": true, "outerCode": 200 } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/deals/{deal-id}/annul": { "post": { "tags": [ "Deals" ], "summary": "Annul a deal for order", "description": "Annul a deal for order", "operationId": "annul-a-deal-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/deals/{deal-id}/capture": { "post": { "tags": [ "Deals" ], "summary": "Capture a deal for order", "description": "Capture a deal for order", "operationId": "capture-a-deal-for-order", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/deals/{deal-id}/refund": { "post": { "tags": [ "Deals" ], "summary": "Refund a deal for order", "description": "Refund a deal for order", "operationId": "refund-a-deal", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Not Implemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/deals/{deal-id}/reserve": { "post": { "tags": [ "Deals" ], "summary": "Reserve a deal for order", "description": "Reserve a deal for order", "operationId": "reserv-a-deal", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deal-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "No Conent" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } }, "501": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfoResponse" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" }, "statusCode": "string", "innerCode": "string", "outerCode": 0 } } } } } } }, "/orders/{order-id}/failure": { "post": { "summary": "Order failure", "description": "Order failure", "operationId": "673377e3fb0ca7ff3014f141", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_OrderPosDataFailure" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/order-confirmation-requests/": { "post": { "summary": "Send order confirmation", "operationId": "send-order-confirmation", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } }, { "name": "Content-Type", "in": "header", "schema": { "enum": [ "" ], "type": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" }, "example": { "email": "string" } } } }, "responses": { "200": { "description": "" }, "409": { "description": "" }, "401": { "description": "" }, "404": { "description": "" }, "403": { "description": "" }, "500": { "description": "" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/payment-session/abort": { "post": { "summary": "Abort Payment session", "description": "Abort a payment session", "operationId": "673376bebcc8f867d0b6cc95", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/payment-session/start": { "post": { "summary": "Start Payment session", "description": "Start a payment session", "operationId": "67336018f4e4e05a85be943a", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_StartPaymentSession" }, "examples": { "default": { "value": null } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pick-lists/{pick-list-item-id}": { "put": { "tags": [ "Order Workflows" ], "summary": "Order picklist set item checked/unchecked", "description": "Used to mark an item/product as prepared on an order.\norder-id = The Order id. \npicklist-item-id = The OrderItem id. ", "operationId": "order-picklist-set-item-checked-unchecked", "parameters": [ { "name": "order-id", "in": "path", "description": "The Order id", "required": true, "schema": { "type": "string" } }, { "name": "pick-list-item-id", "in": "path", "description": "The picklist item id", "required": true, "schema": { "type": "string" } }, { "name": "prepared", "in": "query", "description": "true = item is prepared\nfalse = item is not prepared", "required": true, "schema": { "enum": [ "true", "false" ], "type": "bool" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "Indicates that the prepared status of an order item has been successfully changed." }, "401": { "description": "" }, "403": { "description": "" }, "404": { "description": "Indicates that the order or order item is not found.", "content": { "application/json": {} } } } } }, "/orders/{order-id}/place-order-session/start": { "post": { "summary": "Start Place Order session", "description": "Start a payment session", "operationId": "673457b452989c7dc02d42ce", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": {} } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos-receipt.pdf": { "get": { "summary": "Get pdf for order-id ", "operationId": "6989ea858a55064172422f56", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/pdf": {} } }, "404": { "description": "" }, "401": { "description": "" }, "403": { "description": "" }, "500": { "description": "" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos/canceled": { "post": { "summary": "Cancled Order In Pos", "description": "Canceled Order In Pos", "operationId": "cancled-order-in-pos", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos/canceled-failed": { "post": { "summary": "Canceled Order In Pos Failed", "description": "Canceled Order In Pos Failed", "operationId": "cancled-order-in-pos-failed", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_OrderPosDataFailure" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos/estimated-ready-time/update": { "post": { "summary": "Update Estimated Ready Time", "description": "Update Estimated Ready Time", "operationId": "update-estimated-ready-time", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Content-Type", "in": "header", "schema": { "enum": [ "" ], "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "null" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos/failed": { "post": { "summary": "Place Order In Pos Failed", "description": "Place Order In Pos Failed", "operationId": "place-order-in-pos-failed", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_OrderPosDataFailure" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": { "code": "string", "message": "string", "data": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "innerError": "string" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/pos/placed": { "post": { "summary": "Place Order In Pos", "description": "Place Order In Pos", "operationId": "place-order-in-pos", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_PosData" }, "example": { "orderName": "string", "estimatedReadyTime": "string", "datePlaced": "string", "cancelableUntil": "string", "orderRefsDict": { "additionalProp1": "string" }, "extensions": { "additionalProp1": "string" } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "422": { "description": "" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/ready-for-pickup": { "post": { "tags": [ "Order Workflows" ], "summary": "Set Order status to Ready for pickup", "description": "Set an orders status to Ready for pickup.", "operationId": "set-order-status-as-ready-for-pickup", "parameters": [ { "name": "order-id", "in": "path", "description": "The Order id", "required": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "schema": { "enum": [ "application/json" ], "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "204": { "description": "Indicates that the order status of an order item has been successfully updated." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Indicates that the order is not found." }, "405": { "description": "Method not allowed. The orders current status does not allow to be changed to Ready for pickup." } } } }, "/orders/{order-id}/receipt": { "get": { "summary": "Get receipt for order-id", "operationId": "get-receipt-for-order-id", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "example": { "orderId": "string", "userId": "string", "payments": [ { "transactionId": "string", "amount": 0, "reference": "string", "paymentProviderId": "string", "paymentProviderReference": "string", "paymentReference": "string", "paymentMethod": { "name": "string", "type": "bankAccount", "accountInformation": { "maskedAccountNumber": "string", "bankName": "string" } } } ], "lines": [ { "title": "string", "subItemType": 0, "lineType": "item", "lines": [ "string" ], "linePrice": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "string", "percent": 0 } ] }, "totalPrice": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "string", "percent": 0 } ] }, "unitPrice": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "string", "percent": 0 } ] }, "quantity": 0, "totalQuantity": 0, "refs": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "displayType": "default" } ], "itemsTotal": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "string", "percent": 0 } ] }, "discountsTotal": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "string", "percent": 0 } ] }, "total": { "gross": 0, "net": 0, "vat": [ { "type": "string", "percent": 0, "amount": 0, "basedOn": { "net": 0, "gross": 0 } } ] }, "store": { "storeId": "string", "name": "string", "address": { "line1": "string", "line2": "string", "buildingNumber": "string", "city": "string", "postalCode": "string", "countryIsoCode": "string" }, "phoneNumber": "string", "tzdbTimeZoneId": "string" }, "posData": { "orderName": "string", "estimatedReadyTime": "2024-12-03T09:38:48.736+00:00", "cancelableUntil": "2024-12-03T09:38:48.736+00:00", "datePlaced": "2024-12-03T09:38:48.736+00:00", "receipt": "string" }, "collectionDetails": { "type": "curbside", "carInfoPd": { "registrationNumber": "string", "color": "string", "description": "string" } }, "orderTypeId": "string", "currencyDecimalDigits": 0, "currencyIsoCode": "string", "cultureCode": "string", "readyTime": { "estimated": "2024-12-03T09:38:48.736+00:00" }, "deliveryDropOffTime": { "estimated": "2024-12-03T09:38:48.736+00:00" }, "posCancellationData": { "dateCanceled": "2024-12-03T09:38:48.736+00:00", "receipt": "string" }, "recipientPd": { "phoneNumber": "string", "notes": "string", "name": "string", "courierFacingName": "string", "dropOffLocation": { "position": { "format": "string", "longitude": "string", "latitude": "string" }, "address": { "line1": "string", "line2": "string", "buildingNumber": "string", "postalCode": "string", "city": "string", "countryIsoCode": "string" } } } } } } }, "404": { "description": "" }, "401": { "description": "" }, "403": { "description": "" }, "500": { "description": "" } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/setorderpriority": { "post": { "summary": "Set an order priority", "description": "Set an order priority of the order", "operationId": "set-an-order-priority", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer" ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_SetOrderPriority" }, "example": { "orderPriority": "string" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "405": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "412": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_ErrorInfo" } } } } }, "tags": [ "Orders" ] } }, "/orders/{order-id}/versionId/{version-id}": { "get": { "summary": "Get order with order and version id", "description": "Returns the Order identified by passing the order-id and version in the url.", "operationId": "67d2dc3b3bd9c10c0fdd1ab7", "parameters": [ { "name": "order-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "version-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "Get order by order-id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Order" }, "example": { "orderTypeId": "takeAway", "salesChannel": { "webClientVersion": "", "type": "kiosk", "userAgentString": "", "deviceId": "", "operatingSystem": "" }, "collectionDetails": { "type": "pickup" }, "userId": "79130413-1862-447b-91ca-3d8e8908d268", "payments": [], "items": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7286", "title": "Meal", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7285", "title": "Burger", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7284", "title": "Burger", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7034", "title": "Add", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "1cf4a855-96cc-4355-85c2-f3b9ebb81655", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "1cf4a855-96cc-4355-85c2-f3b9ebb81655.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7035", "title": "Remove", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "f633f457-a233-4244-b741-df37e429694e", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "f633f457-a233-4244-b741-df37e429694e.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7006", "title": "Change", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7001", "title": "Bread", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "64253adb-cf23-4fe6-9c23-893592c81c82", "unitIds": { "328bc913-dbbe-4ef1-9dd6-862529b97cd8.0": [ "64253adb-cf23-4fe6-9c23-893592c81c82.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "328bc913-dbbe-4ef1-9dd6-862529b97cd8", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "328bc913-dbbe-4ef1-9dd6-862529b97cd8.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11613", "title": "Change dressing", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11609", "title": "Original", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "edc873f3-44b8-4d8a-81a5-493c79c4a486", "unitIds": { "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e.0": [ "edc873f3-44b8-4d8a-81a5-493c79c4a486.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e", "unitIds": { "4bd86e59-4c88-4995-ac3a-576c2455ed58.0": [ "620c9bbf-61e8-4176-8d80-7ab6ecd41d7e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "4bd86e59-4c88-4995-ac3a-576c2455ed58", "unitIds": { "3b96c56c-13d6-4cb8-9bd5-5303e9341691.0": [ "4bd86e59-4c88-4995-ac3a-576c2455ed58.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "3b96c56c-13d6-4cb8-9bd5-5303e9341691", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "3b96c56c-13d6-4cb8-9bd5-5303e9341691.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7200", "title": "Change side", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7206", "title": "Crispy fries", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7207", "title": "ConFries2_StdMedFries", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7220", "title": "Fries, medium", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "debbe286-962c-4711-907b-a3253703e46e", "unitIds": { "904d0421-1d63-4b80-a69a-b070e5489389.0": [ "debbe286-962c-4711-907b-a3253703e46e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "904d0421-1d63-4b80-a69a-b070e5489389", "unitIds": { "6d0e2beb-eaaa-415d-a199-d27862e6b368.0": [ "904d0421-1d63-4b80-a69a-b070e5489389.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "6d0e2beb-eaaa-415d-a199-d27862e6b368", "unitIds": { "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455.0": [ "6d0e2beb-eaaa-415d-a199-d27862e6b368.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "fdea8e9f-1b4d-4c2b-a76f-c45b8f994455.0" ] } }, { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "7127", "title": "Ändra dryck?", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11214", "title": "Coca-Cola", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": true, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11215", "title": "ConBev2_StdMedCocaCola", "quantity": 1, "configItems": [ { "subItemType": "none", "isContainer": false, "type": "menuItem", "createDate": "2024-06-05T07:43:11+00:00", "lastModified": "2024-06-05T07:43:11+00:00", "menuItemId": "11241", "title": "Coca-Cola, medium", "quantity": 1, "configItems": [], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "a0947f47-6485-4836-93ea-d77b91a6567e", "unitIds": { "581454c0-d8c8-47e7-9421-45dd9b78bdfa.0": [ "a0947f47-6485-4836-93ea-d77b91a6567e.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "581454c0-d8c8-47e7-9421-45dd9b78bdfa", "unitIds": { "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8.0": [ "581454c0-d8c8-47e7-9421-45dd9b78bdfa.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8", "unitIds": { "3babc9aa-f531-4d68-9f83-5f960c891d93.0": [ "bc0f3e77-36eb-491a-aebe-7bdd86cc5ab8.0" ] } } ], "price": { "amount": 0, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "3babc9aa-f531-4d68-9f83-5f960c891d93", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0": [ "3babc9aa-f531-4d68-9f83-5f960c891d93.0" ] } } ], "price": { "amount": 8200, "isVatIncluded": true, "vat": [ { "type": "12%", "percent": 12 } ] }, "id": "238ae5c7-0e68-4558-8aa0-827a69f93b7d", "unitIds": { "238ae5c7-0e68-4558-8aa0-827a69f93b7d": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" ] } } ], "discounts": [ { "id": "e21801ef-06be-4053-a0bb-eda9eb1f6bdf", "createDate": "2024-06-05T07:43:47+00:00", "lastModified": "2024-06-05T07:43:47+00:00", "dealId": "string", "title": "string", "amounts": [ { "amount": 100, "vat": [ { "type": "string", "percent": 0 } ], "discountedItemId": "238ae5c7-0e68-4558-8aa0-827a69f93b7d", "discountedItemUnitId": "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" } ], "postVat": true, "relatedItemIds": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d" ], "relatedItemUnitIds": [ "238ae5c7-0e68-4558-8aa0-827a69f93b7d.0" ] } ], "currencyIsoCode": "SEK", "currencyDecimalDigits": 2, "mainEventsHistory": [ "Created" ], "storeDetails": { "storeId": null, "tzdbTimeZoneId": "Europe/Paris", "countryIsoCode": "SE", "currencyDecimalDigits": 2 }, "readyTime": { "desired": "2023-10-24T06:20:16+00:00" }, "versionId": "3", "orderId": "AsAVUEr28xh", "storeId": "335", "createDate": "2024-06-05T07:43:04+00:00", "orderRefsDict": {}, "lastModified": "2024-06-05T07:45:02+00:00", "links": {}, "cultureCode": "sv-SE", "discountTotal": -100, "total": 8100, "subtotal": 7232 } } } }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Order not found." } }, "tags": [ "Orders" ] } }, "/orders/{orderId}/workflows/{workflowId}": { "get": { "tags": [ "Order Workflows", "Order Workflows" ], "summary": "Get Workflow", "description": "Get Workflow", "operationId": "workflows", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Workflows" }, "example": { "storeId": "301", "orderId": "asdadsads", "state": { "state": "active", "changedAt": "2023-08-29T12:01:11+00:00", "reason": "created" }, "completedSteps": [ { "name": "ordermanager-show", "trigger": { "type": "automatic", "triggeredAt": "2023-08-29T12:01:11+00:00" } }, { "name": "production-started", "trigger": { "type": "api", "triggeredAt": "2023-08-29T12:03:58+00:00" } }, { "name": "production-completed", "trigger": { "type": "api", "triggeredAt": "2023-08-29T12:03:58+00:00" } } ], "pendingSteps": [ { "name": "delivered", "triggers": [ { "type": "api" }, { "type": "automatic", "details": { "delay": "2024-05-28", "triggersAt": "2023-08-29T02:03:58+00:00" } } ] } ] } } } } } } }, "/orders/{orderId}/workflows/{workflowId}/complete-step": { "post": { "tags": [ "Order Workflows", "Order Workflows" ], "summary": "Complete Workflow Step", "description": "Complete Workflow Step", "operationId": "complete-step", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "workflowId", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication.", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order_Steps" }, "example": { "steps": [ "step-1", "step-2" ] } } } }, "responses": { "200": { "description": "null" } } } }, "/devices/batch/cancel/{job-id}": { "delete": { "summary": "Cancel Batch Job", "operationId": "cancel-batch-job", "parameters": [ { "name": "job-id", "in": "path", "description": "Batch job identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/batch/properties/desired": { "patch": { "summary": "Submit Batch Job", "operationId": "submit-batch-job", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/batch/status/{job-id}": { "get": { "summary": "Get Batch Job Status", "operationId": "get-batch-job-status", "parameters": [ { "name": "job-id", "in": "path", "description": "Batch job identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device": { "get": { "summary": "List Devices", "operationId": "list-devices", "parameters": [ { "name": "deviceType", "in": "query", "description": "Filter by device type (e.g. ~kiosk, ~orb, ~foop). Use ~ prefix for substring match.", "schema": { "type": "string" } }, { "name": "Label", "in": "query", "description": "Filter by device label. Use ~ prefix for substring match.", "schema": { "type": "string" } }, { "name": "Settings:StoreId", "in": "query", "description": "Filter by store ID (exact match).", "schema": { "type": "string" } }, { "name": "Settings:KioskId", "in": "query", "description": "Filter by kiosk name. Use ~ prefix for substring match.", "schema": { "type": "string" } }, { "name": "deviceInfo:deviceName", "in": "query", "description": "Filter by reported device name. Use ~ prefix for substring match.", "schema": { "type": "string" } }, { "name": "Settings:CultureCode", "in": "query", "description": "Filter by culture code (exact match).", "schema": { "type": "string" } }, { "name": "Settings:CountryCode", "in": "query", "description": "Filter by country code (exact match).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/foop": { "post": { "summary": "Create FOOP Device", "operationId": "create-foop-device", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/kiosk": { "post": { "summary": "Create Kiosk Device", "operationId": "create-kiosk-device", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/login/{device-id}": { "get": { "summary": "Get Device Secrets", "operationId": "get-device-secrets", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "post": { "summary": "Create Device Secret", "operationId": "create-device-secret", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/login/{device-id}/{secret-id}": { "delete": { "summary": "Revoke Device Secret", "operationId": "revoke-device-secret", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "secret-id", "in": "path", "description": "Secret identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/orb": { "post": { "summary": "Create ORB Device", "operationId": "create-orb-device", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/setup": { "post": { "summary": "Setup Device", "operationId": "setup-device", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/status": { "get": { "summary": "Device Status", "operationId": "get-device-status", "parameters": [ { "name": "store_ids", "in": "query", "description": "Used to only query a subset of devices beloning to a list of certain storeIds.\ncomma separated list of strings", "schema": { "type": "string" } }, { "name": "device_ids", "in": "query", "description": "Used to only query a subset of devices beloning to a list of certain deviceIds.\ncomma separated list of strings", "schema": { "type": "string" } }, { "name": "minimum_warning_level", "in": "query", "description": "Used to only return devices with a certain severity. ok returns devices with all warning severities, warning returns devices with warning and error and error only returns devices with error severity.\nDeafult is OK.", "schema": { "enum": [ "ok", "warning", "error" ], "type": "string" } }, { "name": "continuation_token", "in": "query", "description": "Used to fetch next page of data.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Used to set the page size limit, default is 100.", "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_Multiple_device_statuses_response" }, "example": { "devices": { "deviceId1": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" }, "deviceId2": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" }, "deviceId3": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" } } } } } }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/status/history": { "get": { "summary": "Device Status History", "operationId": "get-device-status-history", "parameters": [ { "name": "after", "in": "query", "description": "timestamp representing the start time of the query.", "required": true, "schema": { "enum": [ "08/01/2021 00:00:00" ], "type": "string", "default": "08/01/2021 00:00:00" } }, { "name": "before", "in": "query", "description": "timestamp representing the end time of the query.", "schema": { "type": "string" } }, { "name": "store_ids", "in": "query", "description": "array of store-ids to fetch history for.\nArray of strings", "schema": { "type": "array" } }, { "name": "device_ids", "in": "query", "description": "array of device-ids to fetch history for. Array of strings\n", "schema": { "type": "array" } }, { "name": "minimum_warning_level", "in": "query", "description": "the minimum warning level for the telemetry.\nok returns everything, warning returns warning and errors and error returns only errors.", "schema": { "enum": [ "ok", "warning", "error" ], "type": "string", "default": "ok" } }, { "name": "limit", "in": "query", "description": "page size to fetch", "schema": { "enum": [ 100 ], "type": "integer", "default": 100 } }, { "name": "contiuation_token", "in": "query", "description": "use the continuation token when requesting the next page.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_Multiple_device_statuses_response" }, "example": { "devices": { "deviceId1": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" }, "deviceId2": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" }, "deviceId3": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}": { "get": { "summary": "Get Device", "operationId": "get-device", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "delete": { "summary": "Delete Device", "operationId": "delete-device", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/certificate/primary/sas": { "get": { "summary": "Get Device Primary Certificate SAS Key", "operationId": "get-device-certificate-primary-sas", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/certificate/primary/thumbprint": { "get": { "summary": "Get Device Primary Certificate Thumbprint", "operationId": "get-device-certificate-primary-thumbprint", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/certificate/secondary/connectionstring": { "get": { "summary": "Get Device Secondary Certificate Connection String", "operationId": "get-device-certificate-secondary-connectionstring", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/certificate/secondary/connectionstring/checksecret": { "get": { "summary": "Get Device Secondary Certificate Connection String Check Secret", "operationId": "get-device-certificate-secondary-connectionstring-checksecret", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/certificate/secondary/thumbprint": { "get": { "summary": "Get Device Secondary Certificate Thumbprint", "operationId": "get-device-certificate-secondary-thumbprint", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/foop/{module-name}": { "post": { "summary": "Set Device Module", "operationId": "set-device-module", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "module-name", "in": "path", "description": "Module name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "delete": { "summary": "Remove Device Module", "operationId": "remove-device-module", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "module-name", "in": "path", "description": "Module name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/methods/diskloggingsink/uploadFilteredLog": { "post": { "summary": "Upload Device Log Filtered", "operationId": "upload-device-log-filtered", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/methods/diskloggingsink/uploadLog": { "post": { "summary": "Upload Device Log", "operationId": "upload-device-log", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/methods/ping": { "post": { "summary": "Ping Device", "operationId": "ping-device", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/methods/restart": { "post": { "summary": "Restart Device", "operationId": "restart-device", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/methods/{module}/{method}": { "post": { "summary": "Invoke Device Method", "operationId": "invoke-device-method", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "description": "Module name", "required": true, "schema": { "type": "string" } }, { "name": "method", "in": "path", "description": "Method name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/settings/desired": { "get": { "summary": "Get Device Desired Settings", "operationId": "get-device-settings-desired", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "patch": { "summary": "Update Device Desired Settings", "operationId": "patch-device-settings-desired", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/settings/desired/{setting-name}": { "post": { "summary": "Set Individual Desired Setting", "operationId": "post-device-setting-desired", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "setting-name", "in": "path", "description": "Setting name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "delete": { "summary": "Delete Individual Desired Setting", "operationId": "delete-device-setting-desired", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "setting-name", "in": "path", "description": "Setting name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/settings/reported": { "get": { "summary": "Get Device Reported Settings", "operationId": "get-device-settings-reported", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/settings/tags": { "get": { "summary": "Get Device Tags", "operationId": "get-device-settings-tags", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "patch": { "summary": "Update Device Tags", "operationId": "patch-device-settings-tags", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/settings/tags/{setting-name}": { "post": { "summary": "Set Individual Tag", "operationId": "post-device-setting-tag", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "setting-name", "in": "path", "description": "Setting name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/status": { "delete": { "summary": "Delete Device Telemetry Status", "operationId": "delete-device-telemetry-status", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/device/{device-id}/status/event": { "get": { "summary": "Get Device Telemetry Event", "operationId": "get-device-telemetry-event", "parameters": [ { "name": "device-id", "in": "path", "description": "Device identifier", "required": true, "schema": { "type": "string" } }, { "name": "after", "in": "query", "description": "Timestamp representing the start time of the query.", "schema": { "type": "string" } }, { "name": "before", "in": "query", "description": "Timestamp representing the end time of the query.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size.", "schema": { "type": "integer" } }, { "name": "continuation_token", "in": "query", "description": "Used to fetch the next page of data.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/foop/modules/{channel}": { "get": { "summary": "List FOOP Module Names", "operationId": "list-foop-modules", "parameters": [ { "name": "channel", "in": "path", "description": "Release channel", "required": true, "schema": { "enum": [ "stable", "releasecandidate", "preview", "latest" ], "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/foop/modules/{channel}/{module-name}": { "get": { "summary": "Get Foop Module Versions", "operationId": "get-foop-modules-channel-module-name", "parameters": [ { "name": "channel", "in": "path", "description": "Release channel", "required": true, "schema": { "enum": [ "stable", "releasecandidate", "preview", "latest" ], "type": "string" } }, { "name": "module-name", "in": "path", "description": "Module name", "required": true, "schema": { "type": "string" } }, { "name": "top", "in": "query", "description": "Limit number of versions returned", "schema": { "type": "integer" } }, { "name": "version", "in": "query", "description": "Filter by specific version", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/foop/modules/{channel}/{module-name}/{version}": { "get": { "summary": "Get Foop Module Download URL", "operationId": "get-foop-modules-channel-module-name-version", "parameters": [ { "name": "channel", "in": "path", "description": "Release channel", "required": true, "schema": { "enum": [ "stable", "releasecandidate", "preview", "latest" ], "type": "string" } }, { "name": "module-name", "in": "path", "description": "Module name", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Target platform", "schema": { "enum": [ "windows", "linux", "noarch" ], "type": "string" } }, { "name": "cohort", "in": "query", "description": "Cohort validation number", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/status": { "get": { "summary": "Status", "description": "Gets device statuses for all your devices. Paginated responses at 100 devices per call, get the next batch of devices using the continuation token. If needed, one can raise the default limit of 100 devices per response. You can limit the response by filtering by store, deviceIds and minimum warning level.\nThe storeIds and deviceIds query parameters handles multiple values.", "operationId": "status", "parameters": [ { "name": "store_ids", "in": "query", "description": "Used to only query a subset of devices beloning to a list of certain storeIds.\ncomma separated list of strings", "schema": { "type": "string" } }, { "name": "device_ids", "in": "query", "description": "Used to only query a subset of devices beloning to a list of certain deviceIds.\ncomma separated list of strings", "schema": { "type": "string" } }, { "name": "minimum_warning_level", "in": "query", "description": "Used to only return devices with a certain severity. ok returns devices with all warning severities, warning returns devices with warning and error and error only returns devices with error severity.\nDeafult is OK.", "schema": { "enum": [ "ok", "warning", "error" ], "type": "string" } }, { "name": "continuation_token", "in": "query", "description": "Used to fetch next page of data.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Used to set the page size limit, default is 100.", "schema": { "type": "integer" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_Multiple_device_statuses_response" }, "example": { "devices": { "deviceId1": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" }, "deviceId2": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" }, "deviceId3": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-10-13T15:11:32.621+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-10-13T15:11:32.621+00:00", "deviceName": "string" } } } } } }, "400": { "description": "" }, "401": { "description": "" }, "403": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/status/history": { "get": { "summary": "Status History", "description": "Expensive request, use with care. Will be rate limited.", "operationId": "status-history", "parameters": [ { "name": "after", "in": "query", "description": "timestamp representing the start time of the query.", "required": true, "schema": { "enum": [ "08/01/2021 00:00:00" ], "type": "string", "default": "08/01/2021 00:00:00" } }, { "name": "before", "in": "query", "description": "timestamp representing the end time of the query.", "schema": { "type": "string" } }, { "name": "store_ids", "in": "query", "description": "array of store-ids to fetch history for.\nArray of strings", "schema": { "type": "array" } }, { "name": "device_ids", "in": "query", "description": "array of device-ids to fetch history for. Array of strings\n", "schema": { "type": "array" } }, { "name": "minimum_warning_level", "in": "query", "description": "the minimum warning level for the telemetry.\nok returns everything, warning returns warning and errors and error returns only errors.", "schema": { "enum": [ "ok", "warning", "error" ], "type": "string", "default": "ok" } }, { "name": "limit", "in": "query", "description": "page size to fetch", "schema": { "enum": [ 100 ], "type": "integer", "default": 100 } }, { "name": "contiuation_token", "in": "query", "description": "use the continuation token when requesting the next page.", "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_Multiple_device_statuses_response" }, "example": { "devices": { "deviceId1": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" }, "deviceId2": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" }, "deviceId3": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "string", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "string", "deviceName": "string" } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } } }, "tags": [ "Devices" ] } }, "/devices/status/overview": { "get": { "summary": "Status Overview", "description": "Gets a condensed summary of device status for all your devices in one call.", "operationId": "status-overview", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Header", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "The \"devices\"-property contains a list of minimal device statuses.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_status-overview-minimal-response" }, "example": { "devices": [ { "warningLevel": 0, "deviceId": "string", "storeId": "string" } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } } }, "tags": [ "Devices" ] } }, "/devices/template": { "get": { "summary": "List Templates", "operationId": "list-templates", "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/template/{template-name}": { "get": { "summary": "Get Template", "operationId": "get-template", "parameters": [ { "name": "template-name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "post": { "summary": "Create Template", "operationId": "create-template", "parameters": [ { "name": "template-name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] }, "delete": { "summary": "Delete Template", "operationId": "delete-template", "parameters": [ { "name": "template-name", "in": "path", "description": "Template name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/templates/receipt": { "get": { "summary": "Get Receipt Templates", "operationId": "get-receipt-templates", "parameters": [ { "name": "culture", "in": "query", "description": "Culture code filter (e.g. en-US)", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Template type filter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/{device-id}/certificate/primary/connectionstring": { "get": { "summary": "Get Device Connection String", "operationId": "get-certificate-primary-connectionstring", "parameters": [ { "name": "device-id", "in": "path", "description": "device id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/{device-id}/certificate/primary/connectionstring/checksecret": { "get": { "summary": "Check Device Connection String Secret", "operationId": "get-certificate-primary-connectionstring-checksecret", "parameters": [ { "name": "device-id", "in": "path", "description": "device id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": [ "Devices" ] } }, "/devices/{device-id}/status": { "get": { "summary": "Status for Device", "description": "Get device status for a single device-id.", "operationId": "status-for-device", "parameters": [ { "name": "device-id", "in": "path", "description": "device id", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_single-device-response" }, "example": { "sourceType": "string", "deviceId": "string", "storeId": "string", "tenantId": "string", "modules": [ { "moduleName": "string", "heartbeatIsMissing": true, "heartbeatIsMissingSince": "2022-11-15T16:41:49.632+00:00", "subModules": [ "string" ], "moduleStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "sourceType": "string", "warningLevel": 0 } ], "deviceStatuses": [ { "statusName": "string", "statusValue": "string", "warningLevel": 0, "statusId": "string" } ], "warningLevel": 0, "createDate": "2022-11-15T16:41:49.632+00:00", "deviceName": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device_device-status-error" }, "example": { "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } }, "404": { "description": "" } }, "tags": [ "Devices" ] } }, "/rules/": { "post": { "summary": "Create Rule", "description": "Creates a new rule.\nFor more detailed usage instructions see Docs -> Rules", "operationId": "create-rule", "parameters": [ { "name": "Authorization", "in": "header", "description": "JWT Bearer token used for authentication and authorization", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "API version used to make requests.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule_RuleRequestModel" }, "example": { "comment": "string", "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } } } }, "responses": { "200": { "description": "" } }, "tags": [ "Business Rules" ] }, "get": { "summary": "Get All Rules", "description": "Gets all the rules.\nFor more detailed usage instructions see Docs -> Rules", "operationId": "get-all-rules", "parameters": [ { "name": "X-Api-Version", "in": "header", "description": "Api version", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token used for authentication and authorization", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule_GetAllRulesResponse" }, "example": { "rules": [ { "comment": "string", "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } ] } } } } }, "tags": [ "Business Rules" ] } }, "/rules/{rule-id}": { "delete": { "summary": "Delete Rule", "description": "For more detailed usage instructions see Docs -> Rules", "operationId": "delete-rule", "parameters": [ { "name": "rule-id", "in": "path", "required": true, "schema": { "enum": [ "6925af11-9396-489d-a6f0-7e09733d9731" ], "type": "string", "default": "6925af11-9396-489d-a6f0-7e09733d9731" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "responses": { "200": { "description": "" } }, "tags": [ "Business Rules" ] }, "get": { "summary": "Get Rule", "description": "Used to fetch the associated information contained by a rule object.\nFor more detailed usage instructions see Docs -> Rules", "operationId": "get-rule", "parameters": [ { "name": "rule-id", "in": "path", "description": "The rule id is an autogenerated GUID", "required": true, "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule_RuleRequestModel" }, "example": { "comment": "string", "created": { "timeStamp": "string" }, "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } } } } }, "tags": [ "Business Rules" ] }, "put": { "summary": "Update Rule", "description": "Used to update the associated information contained by an existing rule object.\nFor more detailed usage instructions see Docs -> Rules", "operationId": "update-rule", "parameters": [ { "name": "rule-id", "in": "path", "description": "The rule id is an autogenerated GUID", "required": true, "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "description": "API version used to make requests.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "description": "JWT Bearer token used for authentication and authorization", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessRule_RuleRequestModel" }, "example": { "comment": "string", "created": { "timeStamp": "string" }, "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } } } }, "responses": { "200": { "description": "" } }, "tags": [ "Business Rules" ] } }, "/stores/": { "get": { "summary": "GET DataValues", "description": "GET a list of DataValues", "operationId": "get-datavalues", "parameters": [ { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean" } }, { "name": "include_private", "in": "query", "description": "Whether to check for published entities or not", "schema": { "type": "boolean" } }, { "name": "created_at_offset", "in": "query", "description": "Format - date-time (as date-time in RFC3339). Pagination parameter", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Format - int32. Amount per page", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_GET200Values" }, "example": [ { "id": "string", "version": 0, "availability": "Private", "refs": [ "string" ], "draft": true, "deleted": true, "lastUpdateDate": {} } ] } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } } }, "tags": [ "Stores" ] } }, "/stores/{id}": { "get": { "summary": "GET DataValue with {id} and optional {date}", "description": "GET DataValue with {id} and optional {date}", "operationId": "get-datavalue-with-id-and-optional-date", "parameters": [ { "name": "id", "in": "path", "description": "Id of DataValue", "required": true, "schema": { "type": "string" } }, { "name": "include_deleted", "in": "query", "description": "Include deleted DataValues", "schema": { "type": "boolean" } }, { "name": "include_private", "in": "query", "description": "Whether to check for published entities or not", "schema": { "type": "boolean" } }, { "name": "date", "in": "query", "description": "Format - date-time (as date-time in RFC3339). DataValue at specific date", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_GET200ValueById" }, "example": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} } } } }, "400": { "description": "BadRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "422": { "description": "UnprocessableEntity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "500": { "description": "InternalServerError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } }, "501": { "description": "NotImplemented", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store_ErrorInfo" }, "example": { "code": "string", "message": "string", "data": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }, "innerError": "string" } } } } }, "tags": [ "Stores" ] } }, "/users/": { "get": { "summary": "Get Users", "description": "Get multiple user entities.", "operationId": "get-users", "parameters": [ { "name": "id", "in": "query", "description": "The user ID to search for.", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "The email address to search for.", "schema": { "type": "string" } }, { "name": "mobile_phone_number", "in": "query", "description": "The mobile phone number to search for.", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "The username to search for.", "schema": { "type": "string" } }, { "name": "authentication_scheme", "in": "query", "description": "The user authentication scheme to search for.\nRequires provider_tenant_id and provider_user_id to also be set.", "schema": { "type": "string" } }, { "name": "provider_tenant_id", "in": "query", "description": "The user provider tenant ID to search for.\nRequires authentication_scheme and provider_user_id to also be set.", "schema": { "type": "string" } }, { "name": "provider_user_id", "in": "query", "description": "The user provider user ID to search for.\nRequires authentication_scheme and provider_tenant_id to also be set.", "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "responses": { "200": { "description": "Returns a list of all users matching the provided filter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Response__list_" }, "example": [ { "disabled": true, "tenantId": "string", "userId": "string", "username": "string", "legacyAccountType": "string", "name": "string", "friendlyName": "string", "email": "string", "emailVerified": true, "mobilePhoneNumber": "string", "mobilePhoneNumberVerified": true, "userInformation": { "postalCode": { "value": "string", "verified": true }, "birthDate": { "value": "string", "verified": true } }, "localLogin": { "username": "string" }, "externalLogins": [], "deviceLogins": [], "permissionGroups": [ "string" ], "createdAtUtc": "string", "lastTokenIssuedAtUtc": "string", "lastLoginDateUtc": "string", "deletionRequestedAtUtc": "string", "disabledAtUtc": "string" } ] } } } }, "tags": [ "Users" ] } }, "/users/me/communication-preferences": { "get": { "summary": "Get my Communication Preferences", "description": "Get user communications preferences", "operationId": "6527982158a8e5a6453dc15e", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Preference_Response" }, "example": { "communicationChannels": [ { "type": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } ], "communicationReasons": [ { "key": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "supportedCommunicationMethods": [ { "key": "string", "canBeOverridden": true, "isDefault": true, "isActive": true } ] } ], "userId": "string", "tenantId": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] }, "patch": { "summary": "Update my Communication Preferences", "description": "Update User Customer Preferences", "operationId": "65279841a3a5c69cab74ea55", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/User_User_Preferences_Communications_Update" }, "example": { "communicationReasons": [ { "key": "string", "supportedCommunicationMethods": [ { "key": "string", "isActive": true } ] } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Update_User_Communication_Preferences_Response" }, "example": { "key": "string", "supportedCommunicationMethods": [ { "key": "string", "isActive": true } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] } }, "/users/users/me/communication-preferences": { "get": { "summary": "Get User Communication Preferences", "description": "Get user communications preferences", "operationId": "get-user-communication-preferences", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Preference_Response" }, "example": { "communicationChannels": [ { "type": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } ], "communicationReasons": [ { "key": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "supportedCommunicationMethods": [ { "key": "string", "canBeOverridden": true, "isDefault": true, "isActive": true } ] } ], "userId": "string", "tenantId": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] }, "patch": { "summary": "Update User Communication Preferences", "description": "Update User Customer Preferences", "operationId": "update-user-communication-preferences", "parameters": [ { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/User_User_Preferences_Communications_Update" }, "example": { "communicationReasons": [ { "key": "string", "supportedCommunicationMethods": [ { "key": "string", "isActive": true } ] } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Update_User_Communication_Preferences_Response" }, "example": { "key": "string", "supportedCommunicationMethods": [ { "key": "string", "isActive": true } ] } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] } }, "/users/users/{user-id}/communication-preferences": { "get": { "summary": "Get For All Users Communication Preferences ", "description": "Get user communications preferences", "operationId": "635259462cffa666bbc60dc2", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Preference_Response" }, "example": { "communicationChannels": [ { "type": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } ], "communicationReasons": [ { "key": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "supportedCommunicationMethods": [ { "key": "string", "canBeOverridden": true, "isDefault": true, "isActive": true } ] } ], "userId": "string", "tenantId": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] } }, "/users/{user-id}": { "get": { "summary": "Get User", "description": "Get a single user entity.", "operationId": "get-user", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user", "required": true, "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } } ], "responses": { "200": { "description": "Returns the user entity with the provided user ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Response" }, "example": { "disabled": true, "tenantId": "string", "userId": "string", "username": "string", "legacyAccountType": "string", "name": "string", "friendlyName": "string", "email": "string", "emailVerified": true, "mobilePhoneNumber": "string", "mobilePhoneNumberVerified": true, "userInformation": { "postalCode": { "value": "string", "verified": true }, "birthDate": { "value": "string", "verified": true } }, "localLogin": { "username": "string" }, "externalLogins": [], "deviceLogins": [], "permissionGroups": [ "string" ], "createdAtUtc": "string", "lastTokenIssuedAtUtc": "string", "lastLoginDateUtc": "string", "deletionRequestedAtUtc": "string", "disabledAtUtc": "string" } } } }, "404": { "description": "Indicates that no user with that ID exists." } }, "tags": [ "Users" ] }, "delete": { "summary": "Mark User for Deletion", "description": "Mark a user for deletion.", "operationId": "mark-user-for-deletion", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } } ], "responses": { "404": { "description": "Indicates that no user with that ID exists." }, "202": { "description": "The user was successfully marked for deletion." } }, "tags": [ "Users" ] }, "patch": { "summary": "Update User", "description": "Update a user's personal data.", "operationId": "update-user", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } } ], "requestBody": { "description": "A JSON object containing the new personal data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Update_User_Payload" }, "example": { "email": "email@example.com", "mobilePhoneNumber": "+4623123123", "name": "Firstname Lastname", "friendlyName": "Firstname", "emailVerified": true, "mobilePhoneNumberVerified": true } } } }, "responses": { "200": { "description": "Returns the updated user entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Response" }, "example": { "disabled": true, "tenantId": "string", "userId": "string", "username": "string", "legacyAccountType": "string", "name": "string", "friendlyName": "string", "email": "string", "emailVerified": true, "mobilePhoneNumber": "string", "mobilePhoneNumberVerified": true, "userInformation": { "postalCode": { "value": "string", "verified": true }, "birthDate": { "value": "string", "verified": true } }, "localLogin": { "username": "string" }, "externalLogins": [], "deviceLogins": [], "permissionGroups": [ "string" ], "createdAtUtc": "string", "lastTokenIssuedAtUtc": "string", "lastLoginDateUtc": "string", "deletionRequestedAtUtc": "string", "disabledAtUtc": "string" } } } }, "404": { "description": "Indicates that no user with that ID exists." } }, "tags": [ "Users" ] } }, "/users/{user-id}/communication-preferences": { "get": { "summary": "Get Communication Preferences for a specific user", "description": "Get user communications preferences", "operationId": "652797ec494955f323831b7c", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards.", "required": true, "schema": { "enum": [ "0" ], "type": "string", "default": "0" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_User_Preference_Response" }, "example": { "communicationChannels": [ { "type": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } } } ], "communicationReasons": [ { "key": "string", "title": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "description": { "value": "string", "translations": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" } }, "supportedCommunicationMethods": [ { "key": "string", "canBeOverridden": true, "isDefault": true, "isActive": true } ] } ], "userId": "string", "tenantId": "string" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] } }, "/users/{user-id}/communication-preferences/{communication-preference-reason}/communication-methods/{communication-method-key}": { "patch": { "summary": "Updated Communication Preferences for a specific user, reason and method", "description": "Update user communication preference by userId, communication reason and communication method", "operationId": "updated-communication-preferences-for-a-specific-user-reason-and-method", "parameters": [ { "name": "user-id", "in": "path", "description": "The ID of the user.", "required": true, "schema": { "type": "string" } }, { "name": "communication-preference-reason", "in": "path", "description": "The communication preference reason for the notice.", "required": true, "schema": { "type": "string" } }, { "name": "communication-method-key", "in": "path", "description": "The supported communication method for the notice.", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "description": "Token used for authentication", "required": true, "schema": { "enum": [ "Bearer " ], "type": "string", "default": "Bearer " } }, { "name": "X-Api-Version", "in": "header", "description": "Specify which version of API to make request towards.", "required": true, "schema": { "enum": [ "0" ], "type": "string" } } ], "requestBody": { "description": "A JSON object containing the method with new value.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/User_Supported_communication_method" }, "example": { "isActive": true } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Communication_Preference_Not_Found" }, "example": { "communicationReasons": [ { "title": { "value": "Order updates", "translations": { "sv-SE": "Orderuppdateringar", "en-GB": "Order updates", "en-US": "Order updates" } }, "description": { "value": "Updates about the order status", "translations": { "sv-SE": "Uppdateringar om orderns status", "en-GB": "Updates about the order status", "en-US": "Updates about the order status" } }, "supportedCommunicationMethods": [ { "key": "email", "canBeOverridden": false, "isDefault": false, "isActive": false }, { "key": "sms", "canBeOverridden": true, "isDefault": false, "isActive": true }, { "key": "push", "canBeOverridden": true, "isDefault": true, "isActive": true } ], "key": "orderUpdates" }, { "title": { "value": "News, offers and personalized communication", "translations": { "sv-SE": "Nyheter, erbjudanden och personlig kommunikation", "en-GB": "News, offers and personalized communication", "en-US": "News, offers and personalized communication" } }, "description": { "translations": {} }, "supportedCommunicationMethods": [ { "key": "email", "canBeOverridden": false, "isDefault": true, "isActive": false }, { "key": "sms", "canBeOverridden": false, "isDefault": true, "isActive": false }, { "key": "push", "canBeOverridden": true, "isDefault": true, "isActive": true } ], "key": "news" }, { "title": { "value": "Customer survey", "translations": { "sv-SE": "Kundundersökningar", "en-GB": "Customer survey", "en-US": "Customer survey" } }, "description": { "translations": {} }, "supportedCommunicationMethods": [ { "key": "email", "canBeOverridden": false, "isDefault": true, "isActive": false }, { "key": "sms", "canBeOverridden": false, "isDefault": true, "isActive": false }, { "key": "push", "canBeOverridden": true, "isDefault": true, "isActive": true } ], "key": "customerSurvey" } ], "userId": "abc123" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Bad_Request" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Unauthorized" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Forbidden" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Found" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Internal_Server_Error" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } }, "501": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User_Not_Implemented" }, "example": { "errors": [ { "code": "string", "title": "string", "status": 0 } ] } } } } }, "tags": [ "Communication Preferences" ] } }, "/users/{user-id}/send-notification": { "post": { "summary": "Send notification", "description": "Send notification to user", "operationId": "send-notification", "parameters": [ { "name": "user-id", "in": "path", "required": true, "schema": { "type": "" } }, { "name": "X-Api-Version", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "enum": [ "" ], "type": "", "default": "" } } ], "requestBody": { "description": "A JSON object containing the notification", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/User_SendSms" }, "example": { "intent": "TermsOfServiceUpdate1", "countryCode": "US", "content": { "serviceType": "SMS", "message": "This is our new policy update" }, "communicationReason": { "key": "news" } } } } }, "responses": { "200": { "description": "" }, "400": { "description": "" }, "401": { "description": "" }, "404": { "description": "" }, "409": { "description": "" }, "500": { "description": "" } }, "tags": [ "Users" ] } } }, "components": { "schemas": { "Entity_AnyOfDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "references": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ITypeReference" }, "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true } }, "additionalProperties": false }, "Entity_AnyOfDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "references": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_TypeReferenceInputModel" }, "nullable": true } }, "additionalProperties": false }, "Entity_ArrayDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "typeReference": { "$ref": "#/components/schemas/Entity_ITypeReference" }, "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true } }, "additionalProperties": false }, "Entity_ArrayDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "typeReference": { "$ref": "#/components/schemas/Entity_TypeReferenceInputModel" }, "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Entity_ArrayILockOutputModel": { "type": "array", "items": { "required": [ "publisher", "id", "paths", "deleted", "createDate", "lastUpdateDate", "deleteDate", "lastUpdateBy" ], "type": "object", "properties": { "publisher": { "type": "string" }, "id": { "type": "string" }, "paths": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "createDate": { "type": "object" }, "lastUpdateDate": { "type": "object" }, "deleteDate": { "type": "object" }, "lastUpdateBy": { "type": "string" } } } }, "Entity_BaseDataTypeInputModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" }, "baseType": { "enum": [ "String", "Integer", "Boolean", "Float", "Reference", "Dictionary", "Struct", "Array", "Enum", "AnyOf" ], "type": "string" }, "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true } }, "additionalProperties": false }, "Entity_BooleanDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "additionalProperties": false }, "Entity_BooleanDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "additionalProperties": false }, "Entity_ChangeTenantConfigChangeTypeInputModel": { "type": "object", "properties": { "action": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" } }, "example": { "action": "update", "name": "base-thingy", "version": "9.1.60" } }, "Entity_ChangeTenantConfigInputModel": { "type": "object", "properties": { "objectType": { "type": "string", "unrecognizedKeywords": { "readonly": "true" } }, "tenantId": { "type": "string", "unrecognizedKeywords": { "readonly": "true" } }, "changes": { "allOf": [ { "$ref": "#/components/schemas/Entity_ChangeTenantConfigChangeTypeInputModel" } ], "unrecognizedKeywords": { "readonly": "true" } } }, "example": { "objectType": "store", "tenantId": "tenantId", "changes": [ { "action": "update", "name": "base-thingy", "version": "2000-01-04" }, { "action": "add", "name": "base-thangy", "version": "1.0.0" }, { "action": "remove", "name": "old-thingy", "version": "2000-03-02" } ] } }, "Entity_DataBase": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_SerializableRestApiBase" } ], "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "integer", "format": "int32", "readOnly": true }, "parent": { "type": "string", "nullable": true, "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleted": { "type": "boolean", "readOnly": true }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" } }, "additionalProperties": false }, "Entity_DataConnection": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "entityType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string" }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IConnection" }, "nullable": true } }, "additionalProperties": false }, "Entity_DataConnectionInputModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "entityType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string" } }, "additionalProperties": false }, "Entity_DataExtension": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" }, "semanticVersion": { "type": "string", "nullable": true }, "extensionReferences": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_IPropertyReference" } }, "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true } }, "additionalProperties": false }, "Entity_DataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "baseType": { "enum": [ "String", "Integer", "Boolean", "Float", "Reference", "Dictionary", "Struct", "Array", "Enum", "AnyOf" ], "type": "string", "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" }, "semanticVersion": { "type": "string", "nullable": true, "readOnly": true }, "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_DataValue": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" }, "inheritedFrom": { "type": "string", "nullable": true }, "value": { "type": "object", "description": "A JSON object", "nullable": true }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_DataValue" }, "nullable": true }, "draft": { "type": "boolean" }, "refs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "dataLinks": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataLink" }, "nullable": true } }, "additionalProperties": false }, "Entity_DefaultRenderingType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_RenderingType" } ], "additionalProperties": false }, "Entity_DictionaryDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "typeReference": { "$ref": "#/components/schemas/Entity_ITypeReference" }, "regex": { "type": "string", "nullable": true }, "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true }, "renderingMode": { "oneOf": [ { "$ref": "#/components/schemas/Entity_DefaultRenderingType" }, { "$ref": "#/components/schemas/Entity_PositionRenderingType" } ], "nullable": true } }, "additionalProperties": false }, "Entity_DictionaryDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "typeReference": { "$ref": "#/components/schemas/Entity_TypeReferenceInputModel" }, "regex": { "type": "string", "nullable": true, "readOnly": true }, "max": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "min": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "renderingMode": { "oneOf": [ { "$ref": "#/components/schemas/Entity_DefaultRenderingType" }, { "$ref": "#/components/schemas/Entity_PositionRenderingType" } ], "nullable": true } }, "additionalProperties": false }, "Entity_Discriminator": { "type": "object", "properties": { "type": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Entity_DiscriminatorOutputModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true }, "property": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "values": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_EnumDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "enums": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Entity_EnumDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "enums": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Entity_ErrorInfo": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "object", "description": "A JSON object" }, "nullable": true }, "innerError": { "$ref": "#/components/schemas/Entity_ErrorInfo" } }, "additionalProperties": false }, "Entity_ExtensionReferenceInputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_ExtensionReferenceOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_FloatDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "max": { "type": "number", "format": "float", "nullable": true }, "min": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Entity_FloatDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "max": { "type": "number", "format": "float", "nullable": true }, "min": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "Entity_IConnection": { "type": "object", "properties": { "dataId": { "type": "string", "nullable": true, "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string", "readOnly": true } }, "additionalProperties": false }, "Entity_IDataConnectionOutputModel": { "type": "object", "properties": { "entityType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string", "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" } }, "additionalProperties": false }, "Entity_IDataExtension": { "type": "object", "properties": { "extensionReferences": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_IPropertyReference" } }, "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "integer", "format": "int32", "readOnly": true }, "parent": { "type": "string", "nullable": true, "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" }, "semanticVersion": { "type": "string", "nullable": true, "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" } }, "additionalProperties": false }, "Entity_IDataExtensionInputModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true, "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string", "readOnly": true }, "extensionReferences": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_PropertyReferenceInputModel" } }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IDataExtensionOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true, "readOnly": true }, "internalVersion": { "type": "integer", "format": "int32", "readOnly": true }, "baseType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string", "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string", "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "extensionReferences": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_PropertyReferenceOutputModel" } }, "nullable": true, "readOnly": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" }, "nullable": true, "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IDataLink": { "type": "object", "properties": { "active": { "type": "boolean", "readOnly": true }, "version": { "type": "integer", "format": "int32", "readOnly": true }, "dataId": { "type": "string", "nullable": true, "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IDataTypeInputModel": { "oneOf": [ { "$ref": "#/components/schemas/Entity_ArrayDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_BooleanDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_DictionaryDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_EnumDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_FloatDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_IntegerDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_StructDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_ReferenceDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_StringDataTypeInputModel" }, { "$ref": "#/components/schemas/Entity_AnyOfDataTypeInputModel" } ] }, "Entity_IDataTypeOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true, "readOnly": true }, "internalVersion": { "type": "integer", "format": "int32", "readOnly": true }, "baseType": { "type": "string", "nullable": true, "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string", "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "min": { "type": "object", "description": "A JSON object", "nullable": true, "readOnly": true }, "max": { "type": "object", "description": "A JSON object", "nullable": true, "readOnly": true }, "regex": { "type": "string", "nullable": true, "readOnly": true }, "typeReference": { "$ref": "#/components/schemas/Entity_TypeReferenceOutputModel" }, "enums": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "propertyReferences": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_PropertyReferenceOutputModel" }, "nullable": true, "readOnly": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_TypeReferenceOutputModel" }, "nullable": true, "readOnly": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" }, "nullable": true, "readOnly": true }, "discriminator": { "$ref": "#/components/schemas/Entity_DiscriminatorOutputModel" }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IExtensionMinimalOutputModel": { "type": "object", "properties": { "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string", "readOnly": true }, "baseType": { "enum": [ "Type", "Extension", "Config", "Schema", "Value", "Reference" ], "type": "string", "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IExtensionReference": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "dataId": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_ILockInputModel": { "type": "object", "properties": { "id": { "type": "string" }, "paths": { "type": "array", "items": { "type": "string" } } } }, "Entity_ILockOutputModel": { "type": "object", "properties": { "publisher": { "type": "string" }, "id": { "type": "string" }, "paths": { "type": "array", "items": { "type": "string" } }, "deleted": { "type": "boolean" }, "createDate": { "type": "object" }, "lastUpdateDate": { "type": "object" }, "deleteDate": { "type": "object" }, "lastUpdateBy": { "type": "string" } } }, "Entity_Instant": { "type": "object", "additionalProperties": false }, "Entity_IntegerDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "max": { "type": "integer", "format": "int32", "nullable": true }, "min": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Entity_IntegerDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "max": { "type": "integer", "format": "int32", "nullable": true }, "min": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Entity_IPropertyReference": { "type": "object", "properties": { "required": { "type": "boolean", "readOnly": true }, "secret": { "type": "boolean", "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "dataId": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_IReference": { "type": "object", "properties": { "objectsId": { "type": "string", "nullable": true, "readOnly": true }, "referenceId": { "type": "string", "nullable": true, "readOnly": true }, "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "integer", "format": "int32", "readOnly": true }, "parent": { "type": "string", "nullable": true, "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" } }, "additionalProperties": false }, "Entity_ISchemaOutputModel": { "type": "object", "properties": { "internalVersion": { "type": "integer", "format": "int32", "readOnly": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_PropertyReferenceOutputModel" }, "nullable": true, "readOnly": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" }, "nullable": true, "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_ITenantConfigInputModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "extensionReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ExtensionReferenceInputModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_ITenantConfigOutputModel": { "type": "object", "properties": { "tenantId": { "type": "string", "nullable": true, "readOnly": true }, "internalVersion": { "type": "integer", "format": "int32", "readOnly": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "deleted": { "type": "boolean", "readOnly": true }, "extensionReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_ExtensionReferenceOutputModel" }, "nullable": true, "readOnly": true }, "dataExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataExtensionOutputModel" }, "nullable": true, "readOnly": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataTypeOutputModel" }, "nullable": true, "readOnly": true }, "createDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" }, "deleteDate": { "$ref": "#/components/schemas/Entity_Instant" }, "lastUpdateBy": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_ITypeMinimalOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "string", "nullable": true, "readOnly": true }, "baseType": { "type": "string", "nullable": true, "readOnly": true }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_ITypeReference": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true, "readOnly": true }, "dataId": { "type": "string", "nullable": true, "readOnly": true }, "semanticVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_PositionRenderingType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_RenderingType" } ], "additionalProperties": false }, "Entity_PropertiesExistsDiscriminator": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_Discriminator" } ], "properties": { "properties": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Entity_PropertyReferenceInputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "secret": { "type": "boolean" } }, "additionalProperties": false }, "Entity_PropertyReferenceOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "isSecret": { "type": "boolean" } }, "additionalProperties": false }, "Entity_PropertyValueInDiscriminator": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_Discriminator" } ], "properties": { "property": { "type": "string", "nullable": true }, "values": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Entity_Reference": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "objectsId": { "type": "string", "nullable": true }, "referenceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_ReferenceDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "additionalProperties": false }, "Entity_ReferenceDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "additionalProperties": false }, "Entity_RenderingType": { "type": "object", "properties": { "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_Schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "propertyReferences": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_IPropertyReference" }, "nullable": true } }, "additionalProperties": false }, "Entity_SerializableRestApiBase": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Entity_StringDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "min": { "type": "integer", "format": "int32", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true }, "regex": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_StringDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "regex": { "type": "string", "nullable": true }, "max": { "type": "integer", "format": "int32", "nullable": true }, "min": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Entity_StructDataType": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataType" } ], "properties": { "discriminator": { "oneOf": [ { "$ref": "#/components/schemas/Entity_PropertiesExistsDiscriminator" }, { "$ref": "#/components/schemas/Entity_PropertyValueInDiscriminator" }, { "$ref": "#/components/schemas/Entity_ValueValidatesDiscriminator" } ], "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "propertyReferences": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_IPropertyReference" }, "nullable": true } }, "additionalProperties": false }, "Entity_StructDataTypeInputModel": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_BaseDataTypeInputModel" } ], "properties": { "propertyReferences": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Entity_PropertyReferenceInputModel" }, "nullable": true } }, "additionalProperties": false }, "Entity_TenantConfig": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_DataBase" } ], "properties": { "extensionReferences": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IExtensionReference" }, "nullable": true }, "relatedDataTypes": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_DataType" }, "nullable": true }, "relatedDataExtensions": { "type": "array", "items": { "$ref": "#/components/schemas/Entity_IDataExtension" }, "nullable": true } }, "additionalProperties": false }, "Entity_TypeReferenceInputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_TypeReferenceOutputModel": { "type": "object", "properties": { "publisher": { "type": "string", "nullable": true }, "dataId": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Entity_ValueMinimalOutputModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "availability": { "enum": [ "Private", "Published", "Public" ], "type": "string" }, "refs": { "type": "array", "items": { "type": "string" }, "nullable": true }, "draft": { "type": "boolean" }, "deleted": { "type": "boolean" }, "lastUpdateDate": { "$ref": "#/components/schemas/Entity_Instant" } }, "additionalProperties": false }, "Entity_ValueValidatesDiscriminator": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Entity_Discriminator" } ], "additionalProperties": false }, "MDOrchestration_authenticationConfiguration": { "type": "object", "properties": { "authenticationType": { "enum": [ "FO", "BASIC" ], "type": "string", "default": "FO" }, "username": { "type": "string" }, "password": { "type": "string" }, "scope": { "type": "string" } } }, "MDOrchestration_authenticationConfigurationDto": { "type": "object", "properties": { "authenticationType": { "enum": [ "FO", "BASIC" ], "type": "string", "default": "FO", "nullable": true }, "scope": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } } }, "MDOrchestration_completeReport": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MDOrchestration_dataEntity" } } } }, "MDOrchestration_completeReportCreationDto": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MDOrchestration_dataEntityDto" } } } }, "MDOrchestration_dataEntity": { "type": "object", "properties": { "references": { "type": "array", "items": { "type": "string" } }, "dataSources": { "type": "array", "items": { "type": "string" } }, "route": { "type": "string" } } }, "MDOrchestration_dataEntityDto": { "type": "object", "properties": { "references": { "type": "array", "items": { "type": "string" } }, "dataSources": { "type": "array", "items": { "type": "string" } }, "route": { "type": "string" } } }, "MDOrchestration_errorInfo": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "innerError": { "$ref": "#/components/schemas/MDOrchestration_errorInfo" } } }, "MDOrchestration_errorInfoDto": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "innerError": { "$ref": "#/components/schemas/MDOrchestration_errorInfoDto" } } }, "MDOrchestration_errorReport": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "error": { "$ref": "#/components/schemas/MDOrchestration_errorInfo" } } }, "MDOrchestration_errorReportCreationDto": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "error": { "$ref": "#/components/schemas/MDOrchestration_errorInfoDto" } } }, "MDOrchestration_flow": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "jobIds": { "type": "array", "items": { "type": "string" } }, "entityType": { "enum": [ "stores", "menus" ], "type": "string", "default": "stores" }, "startProcedure": { "$ref": "#/components/schemas/MDOrchestration_startProcedure" } } }, "MDOrchestration_flowCreationDto": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "type": "string" } }, "entityType": { "type": "string" }, "startProcedure": { "$ref": "#/components/schemas/MDOrchestration_startProcedureDto" } } }, "MDOrchestration_job": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "entityType": { "enum": [ "stores", "menus" ], "type": "string", "default": "stores" }, "configuration": { "type": "object" }, "timeOut": { "$ref": "#/components/schemas/MDOrchestration_timeSpan" }, "failOnTimeOut": { "type": "boolean" }, "authenticationConfiguration": { "$ref": "#/components/schemas/MDOrchestration_authenticationConfiguration" } } }, "MDOrchestration_jobCreationDto": { "type": "object", "properties": { "url": { "type": "string" }, "description": { "type": "string" }, "entityType": { "type": "string" }, "configuration": { "type": "object" }, "timeOut": { "type": "string" }, "failOnTimeOut": { "type": "boolean", "nullable": true }, "authenticationConfiguration": { "$ref": "#/components/schemas/MDOrchestration_authenticationConfigurationDto" } } }, "MDOrchestration_logEntry": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "flowId": { "type": "string" }, "runId": { "type": "string" }, "logReport": { "$ref": "#/components/schemas/MDOrchestration_logReport" }, "createdAt": { "type": "string", "format": "date-time" } } }, "MDOrchestration_logReport": { "type": "object", "properties": { "logReportType": { "enum": [ "Start", "StartProcess", "Progress", "Error", "Complete", "JobChange", "End", "Internal" ], "type": "string", "default": "Start" }, "jobId": { "type": "string" }, "position": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/MDOrchestration_dataEntity" } } } }, "MDOrchestration_progressReport": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "status": { "enum": [ "RUNNING", "WAITING", "LOADING", "TRANSFERRING", "DOWNLOADING", "PATCHING", "MERGING" ], "type": "string", "default": "RUNNING" }, "information": { "type": "string" } } }, "MDOrchestration_progressReportCreationDto": { "type": "object", "properties": { "flowId": { "type": "string" }, "jobId": { "type": "string" }, "runId": { "type": "string" }, "status": { "type": "string" }, "information": { "type": "string" } } }, "MDOrchestration_run": { "type": "object", "properties": { "id": { "type": "string" }, "tenantId": { "type": "string" }, "flowId": { "type": "string" }, "position": { "type": "integer", "format": "int32", "nullable": true }, "startingIdentifiers": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Active", "Failed", "Completed" ], "type": "string", "default": "Active" } } }, "MDOrchestration_runCreationDto": { "type": "object", "properties": { "flowId": { "type": "string" }, "position": { "type": "integer", "format": "int32", "nullable": true }, "startingIdentifiers": { "type": "array", "items": { "type": "string" } } } }, "MDOrchestration_runEntityDto": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object" } } } }, "MDOrchestration_runEntityResponseDto": { "type": "object", "properties": { "url": { "type": "string" } } }, "MDOrchestration_startProcedure": { "type": "object", "properties": { "startProcedureType": { "enum": [ "NONE", "RUN", "MANUAL" ], "type": "string", "default": "NONE" }, "identifiers": { "type": "array", "items": { "type": "string" } } } }, "MDOrchestration_startProcedureDto": { "type": "object", "properties": { "startProcedureType": { "type": "string" }, "identifiers": { "type": "array", "items": { "type": "string" } } } }, "MDOrchestration_timer": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "timesOfDay": { "type": "array", "items": { "type": "string" } }, "flowId": { "type": "string" }, "startingIdentifiers": { "type": "array", "items": { "type": "string" } }, "jobId": { "type": "string" } }, "example": { "from": "string", "to": "string", "timesOfDay": [ "string" ], "flowId": "string", "startingIdentifiers": [ "string" ], "jobId": "string" } }, "MDOrchestration_timeSpan": { "type": "object", "properties": { "ticks": { "type": "integer", "format": "int64" }, "days": { "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32" }, "milliseconds": { "type": "integer", "format": "int32" }, "minutes": { "type": "integer", "format": "int32" }, "seconds": { "type": "integer", "format": "int32" }, "totalDays": { "type": "number", "format": "double" }, "totalHours": { "type": "number", "format": "double" }, "totalMilliseconds": { "type": "number", "format": "double" }, "totalMinutes": { "type": "number", "format": "double" }, "totalSeconds": { "type": "number", "format": "double" } } }, "FrontendPlugin_Banner_Group_Creation_Request": { "type": "object", "properties": { "displayName": { "type": "string" }, "selector": { "type": "object", "properties": { "cultureCodes": { "type": "array", "items": { "type": "string" } }, "storeIds": { "type": "array", "items": { "type": "integer" } }, "countryCodes": { "type": "array", "items": { "type": "string" } } } }, "promotionGroups": { "type": "array", "items": { "required": [ "id", "categoryIds", "promotionItems" ], "type": "object", "properties": { "id": { "type": "string" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "promotionItems": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } } } } } } }, "x-apim-schema-name": "Banner Group Creation Request" }, "FrontendPlugin_Banner_Group_Update_Request": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "selector": { "type": "object", "properties": { "cultureCodes": { "type": "array", "items": { "type": "string" } }, "storeIds": { "type": "array", "items": { "type": "integer" } }, "countryCodes": { "type": "array", "items": { "type": "string" } } } }, "promotionGroups": { "type": "array", "items": { "required": [ "id", "categoryIds", "promotionItems" ], "type": "object", "properties": { "id": { "type": "string" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "promotionItems": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } } } } } } }, "x-apim-schema-name": "Banner Group Update Request" }, "FrontendPlugin_Banner_Promotion_Creation_Request": { "type": "object", "properties": { "displayName": { "type": "string" }, "image": { "type": "string" }, "altText": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "params": { "type": "object", "properties": { "categoryId": { "type": "integer" } } } } } }, "x-apim-schema-name": "Banner Promotion Creation Request" }, "FrontendPlugin_Banner_Promotion_Update_Request": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "image": { "type": "string" }, "altText": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "params": { "type": "object", "properties": { "categoryId": { "type": "integer" } } } } } }, "x-apim-schema-name": "Banner Promotion Update Request" }, "FrontendPlugin_Get_Banners_Data_Response": { "type": "object", "properties": { "current": { "type": "object", "properties": { "promotions": { "type": "array", "items": { "required": [ "id", "displayName", "image", "altText", "tenantId" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "image": { "type": "string" }, "altText": { "type": "string" }, "tenantId": { "type": "string" } } } }, "groups": { "type": "array", "items": { "required": [ "id", "displayName", "promotionGroups", "tenantId" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "promotionGroups": { "type": "array", "items": { "required": [ "id", "categoryIds", "promotionItems" ], "type": "object", "properties": { "id": { "type": "string" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "promotionItems": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } } } } } }, "tenantId": { "type": "string" } } } } } }, "published": { "type": "object", "properties": { "promotions": { "type": "array", "items": { "required": [ "id", "displayName", "image", "altText", "tenantId" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "image": { "type": "string" }, "altText": { "type": "string" }, "tenantId": { "type": "string" } } } }, "groups": { "type": "array", "items": { "required": [ "id", "displayName", "promotionGroups", "tenantId" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "promotionGroups": { "type": "array", "items": { "required": [ "id", "categoryIds", "promotionItems" ], "type": "object", "properties": { "id": { "type": "string" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "promotionItems": { "type": "array", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" } } } } } } }, "tenantId": { "type": "string" } } } } } }, "lastPublishedAt": { "type": "string" } }, "x-apim-schema-name": "Get Banners Data Response" }, "FrontendPlugin_Get_Slideshows_Data_Response": { "type": "object", "properties": { "current": { "type": "object", "properties": { "promotions": { "type": "array", "items": { "required": [ "id", "displayName", "portrait", "portraitAltText", "landscape", "landscapeAltText", "tenantId", "themeColor", "tags", "action", "durationOverride" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "portrait": { "type": "string" }, "portraitAltText": { "type": "string" }, "landscape": { "type": "string" }, "landscapeAltText": { "type": "string" }, "tenantId": { "type": "string" }, "themeColor": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" } } }, "durationOverride": { "type": "integer" } } } }, "slideshows": { "type": "array", "items": { "required": [ "id", "displayName", "slides", "tenantId", "slideInterval", "selector" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "slides": { "type": "array", "items": { "required": [ "promotionId" ], "type": "object", "properties": { "promotionId": { "type": "string" } } } }, "tenantId": { "type": "string" }, "slideInterval": { "type": "integer" }, "selector": { "type": "object", "properties": { "countryCodes": { "type": "array", "items": { "type": "string" } } } } } } } } }, "published": { "type": "object", "properties": { "promotions": { "type": "array", "items": { "required": [ "id", "displayName", "portrait", "portraitAltText", "landscape", "landscapeAltText", "tenantId", "themeColor", "tags", "action", "durationOverride" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "portrait": { "type": "string" }, "portraitAltText": { "type": "string" }, "landscape": { "type": "string" }, "landscapeAltText": { "type": "string" }, "tenantId": { "type": "string" }, "themeColor": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" } } }, "durationOverride": { "type": "integer" } } } }, "slideshows": { "type": "array", "items": { "required": [ "id", "displayName", "slides", "tenantId", "slideInterval", "selector" ], "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "slides": { "type": "array", "items": { "required": [ "promotionId" ], "type": "object", "properties": { "promotionId": { "type": "string" } } } }, "tenantId": { "type": "string" }, "slideInterval": { "type": "integer" }, "selector": { "type": "object", "properties": { "countryCodes": { "type": "array", "items": { "type": "string" } } } } } } } } }, "lastPublishedAt": { "type": "string" } }, "x-apim-schema-name": "Get Slideshows Data Response" }, "FrontendPlugin_Hero_Promotion_Creation_Request": { "type": "object", "properties": { "displayName": { "type": "string" }, "portrait": { "type": "string" }, "portraitAltText": { "type": "string" }, "landscape": { "type": "string" }, "landscapeAltText": { "type": "string" }, "themeColor": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "params": { "type": "object", "properties": { "categoryId": { "type": "integer" }, "menuType": { "type": "string" }, "code": { "type": "string" }, "productAdd": { "type": "string" } } } } } }, "example": { "displayName": "string", "portrait": "string", "portraitAltText": "string", "landscape": "string", "landscapeAltText": "string", "themeColor": "string", "tags": [ "string" ], "action": { "type": "string", "params": { "categoryId": 0, "menuType": "string", "code": "string", "productAdd": "string" } } }, "x-apim-schema-name": "Hero Promotion Creation Request" }, "FrontendPlugin_Hero_Promotion_Update_Request": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "portrait": { "type": "string" }, "portraitAltText": { "type": "string" }, "landscape": { "type": "string" }, "landscapeAltText": { "type": "string" }, "themeColor": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "action": { "type": "object", "properties": { "type": { "type": "string" }, "params": { "type": "object", "properties": { "categoryId": { "type": "integer" }, "menuType": { "type": "string" }, "code": { "type": "string" }, "productAdd": { "type": "string" } } } } } }, "x-apim-schema-name": "Hero Promotion Update Request" }, "FrontendPlugin_PluginConfig": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "config": { "type": "object", "nullable": true }, "channels": { "type": "array", "items": { "enum": [ "kiosk", "foapp" ] }, "nullable": true }, "countryCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "consentLevels": { "type": "array", "items": { "enum": [ "standard", "preferences", "statistics", "marketing" ] }, "nullable": true }, "appTrackingConsent": { "type": "boolean", "nullable": true }, "dependentOn": { "type": "array", "items": { "type": "string" }, "nullable": true }, "paused": { "type": "boolean", "nullable": true }, "allowedDataUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "removeAt": { "type": "string", "format": "date-time", "nullable": true }, "esm": { "type": "boolean", "nullable": true } } }, "FrontendPlugin_PluginManifest": { "type": "object", "properties": { "version": { "type": "string" }, "description": { "type": "string", "nullable": true }, "esm": { "type": "boolean", "nullable": true }, "parameters": { "type": "array", "items": {} }, "hidden": { "type": "boolean", "nullable": true }, "deprecated": { "type": "boolean", "nullable": true } } }, "FrontendPlugin_Slideshow_Creation_Request": { "type": "object", "properties": { "displayName": { "type": "string" }, "slides": { "type": "array", "items": { "required": [ "promotionId" ], "type": "object", "properties": { "promotionId": { "type": "string" }, "periodConstraints": { "type": "object" } } } }, "slideInterval": { "type": "integer" }, "selector": { "type": "object", "properties": { "channel": { "type": "string" }, "storeIds": { "type": "array", "items": { "type": "integer" } }, "cultureCodes": { "type": "array", "items": { "type": "string" } }, "countryCodes": { "type": "array", "items": { "type": "string" } } } } }, "x-apim-schema-name": "Slideshow Creation Request" }, "FrontendPlugin_Slideshow_Update_Request": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "slides": { "type": "array", "items": { "required": [ "promotionId" ], "type": "object", "properties": { "promotionId": { "type": "string" }, "periodConstraints": { "type": "object" } } } }, "slideInterval": { "type": "integer" }, "selector": { "type": "object", "properties": { "channel": { "type": "string" }, "storeIds": { "type": "array", "items": { "type": "integer" } }, "cultureCodes": { "type": "array", "items": { "type": "string" } }, "countryCodes": { "type": "array", "items": { "type": "string" } } } } }, "x-apim-schema-name": "Slideshow Update Request" }, "FrontendPlugin_Touchpoint_Session": { "type": "object", "properties": { "sessionId": { "type": "string" }, "tenantId": { "type": "string" }, "storeId": { "type": "string" }, "countryCode": { "type": "string" }, "status": { "type": "string" }, "owner": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" } } }, "observers": { "type": "array", "items": { "required": [ "userId", "name" ], "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "imageSrc": { "type": "string" } } } }, "device": { "type": "object", "properties": { "isAuthenticated": { "type": "boolean" }, "deviceId": { "type": "string" } } }, "orderId": { "type": "string" }, "createdAt": { "type": "string" }, "alerts": { "type": "array", "items": { "required": [ "type", "message", "timestamp" ], "type": "object", "properties": { "type": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" } } } } }, "x-apim-schema-name": "Touchpoint Session" }, "FrontendPlugin_Touchpoint_Session_GET_Success": { "$ref": "#/components/schemas/Touchpoint Session" }, "PaymentProvider_CardInformation": { "type": "object", "properties": { "maskedCardNumber": { "type": "string", "nullable": true }, "cardExpiry": { "type": "string", "nullable": true }, "cardIssuer": { "type": "string", "nullable": true }, "cardBrand": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentProvider_EmvPaymentCardInstrument": { "required": [ "cardInformation", "emvData" ], "type": "object", "properties": { "paymentInstrumentType": { "enum": [ "EmvPaymentCard" ], "type": "string" }, "cardInformation": { "$ref": "#/components/schemas/PaymentProvider_CardInformation" }, "emvData": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentProvider_StringStringKeyValuePair" } } }, "additionalProperties": false }, "PaymentProvider_MinimalPaymentInstrument": { "type": "object", "properties": { "paymentInstrumentType": { "enum": [ "Minimal" ], "type": "string" } }, "additionalProperties": false }, "PaymentProvider_PaymentCardInstrument": { "required": [ "expiry", "maskedCardNumber" ], "type": "object", "properties": { "paymentInstrumentType": { "enum": [ "PaymentCard" ], "type": "string" }, "maskedCardNumber": { "minLength": 1, "type": "string" }, "expiry": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PaymentProvider_PaymentErrorDetail": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "target": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentProvider_PaymentErrorResponse": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentProvider_PaymentErrorDetail" }, "nullable": true } }, "additionalProperties": false }, "PaymentProvider_PaymentMethod": { "required": [ "name", "paymentInstrument" ], "type": "object", "properties": { "name": { "minLength": 1, "enum": [ "ApplePay", "Blik", "CardPayment", "Deferred", "DirectDebit", "Invoice", "MobilePay", "StoredValuePayment", "Swish", "Vipps" ], "type": "string" }, "paymentInstrument": { "oneOf": [ { "$ref": "#/components/schemas/PaymentProvider_EmvPaymentCardInstrument" }, { "$ref": "#/components/schemas/PaymentProvider_MinimalPaymentInstrument" }, { "$ref": "#/components/schemas/PaymentProvider_PaymentCardInstrument" } ] } }, "additionalProperties": false }, "PaymentProvider_PaymentTransactionAnnulmentFailed": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.annulment_failed.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentFailedData" } } }, "PaymentProvider_PaymentTransactionAnnulmentFailedData": { "required": [ "errorCode", "errorMessage", "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "errorCode": { "minLength": 1, "type": "string" }, "errorMessage": { "minLength": 1, "type": "string" } } }, "PaymentProvider_PaymentTransactionAnnulmentSucceeded": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.annulment_succeeded.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAnnulmentSucceededData" } } }, "PaymentProvider_PaymentTransactionAnnulmentSucceededData": { "required": [ "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true } } }, "PaymentProvider_PaymentTransactionAuthorizationFailed": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.authorization_failed.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationFailedData" } } }, "PaymentProvider_PaymentTransactionAuthorizationFailedData": { "required": [ "errorCode", "errorMessage", "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "errorCode": { "minLength": 1, "type": "string" }, "errorMessage": { "minLength": 1, "type": "string" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentProvider_PaymentMethod" }, "pspReference": { "type": "string", "nullable": true } } }, "PaymentProvider_PaymentTransactionAuthorizationSucceeded": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.authorization_succeeded.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionAuthorizationSucceededData" } } }, "PaymentProvider_PaymentTransactionAuthorizationSucceededData": { "required": [ "merchantId", "operationId", "paymentMethod", "pspReference" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/PaymentProvider_PaymentMethod" }, "pspReference": { "minLength": 1, "type": "string" } } }, "PaymentProvider_PaymentTransactionCaptureFailed": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.capture_failed.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureFailedData" } } }, "PaymentProvider_PaymentTransactionCaptureFailedData": { "required": [ "errorCode", "errorMessage", "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "errorCode": { "minLength": 1, "type": "string" }, "errorMessage": { "minLength": 1, "type": "string" } } }, "PaymentProvider_PaymentTransactionCaptureSucceeded": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.capture_succeeded.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionCaptureSucceededData" } } }, "PaymentProvider_PaymentTransactionCaptureSucceededData": { "required": [ "merchantId", "operationId", "amount", "currency" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "currency": { "maxLength": 3, "minLength": 3, "type": "string" }, "amount": { "maximum": 9223372036854775800, "minimum": 1.0, "type": "integer", "format": "int64" } } }, "PaymentProvider_PaymentTransactionRegistrationCancelled": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.registration_cancelled.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationCancelledData" } } }, "PaymentProvider_PaymentTransactionRegistrationCancelledData": { "required": [ "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true } } }, "PaymentProvider_PaymentTransactionRegistrationFailed": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.registration_failed.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationFailedData" } } }, "PaymentProvider_PaymentTransactionRegistrationFailedData": { "required": [ "errorCode", "errorMessage", "merchantId", "operationId" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "errorCode": { "minLength": 1, "type": "string" }, "errorMessage": { "minLength": 1, "type": "string" } } }, "PaymentProvider_PaymentTransactionRegistrationSucceeded": { "required": [ "data", "datacontenttype", "id", "source", "specversion", "subject", "time", "type" ], "properties": { "specversion": { "enum": [ "1.0" ], "type": "string" }, "datacontenttype": { "enum": [ "application/json" ], "type": "string" }, "type": { "enum": [ "payment.external.transaction.registration_succeeded.v1" ], "type": "string" }, "id": { "minLength": 1, "type": "string" }, "source": { "type": "string", "format": "uri" }, "time": { "type": "string", "format": "date-time" }, "subject": { "minLength": 1, "type": "string" }, "data": { "$ref": "#/components/schemas/PaymentProvider_PaymentTransactionRegistrationSucceededData" } } }, "PaymentProvider_PaymentTransactionRegistrationSucceededData": { "required": [ "merchantId", "operationId", "amount", "currency" ], "properties": { "merchantId": { "minLength": 1, "type": "string" }, "operationId": { "minLength": 1, "type": "string" }, "deviceId": { "type": "string", "nullable": true }, "currency": { "maxLength": 3, "minLength": 3, "type": "string" }, "amount": { "maximum": 9223372036854775800, "minimum": 1.0, "type": "integer", "format": "int64" } } }, "PaymentProvider_StringStringKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Order_AnnulDealResult": { "type": "object", "properties": { "statusCode": { "$ref": "#/components/schemas/Order_StatusCode" }, "message": { "type": "string", "nullable": true }, "innerCode": { "type": "string", "nullable": true }, "successful": { "type": "boolean", "readOnly": true }, "outerCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Order_BankAccountInformation": { "type": "object", "properties": { "maskedAccountNumber": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Order_BasedOnPrice": { "type": "object", "properties": { "net": { "type": "integer", "format": "int64" }, "gross": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Order_CaptureDealResult": { "type": "object", "properties": { "statusCode": { "$ref": "#/components/schemas/Order_StatusCode" }, "message": { "type": "string", "nullable": true }, "innerCode": { "type": "string", "nullable": true }, "successful": { "type": "boolean", "readOnly": true }, "outerCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Order_Cardinfo": { "type": "object", "properties": { "maskedCardNumber": { "type": "string", "nullable": true }, "cardExpiry": { "type": "string", "nullable": true }, "cardIssuer": { "type": "string", "nullable": true }, "cardBrand": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Order_Category": { "type": "object", "properties": { "categoryId": { "type": "string", "nullable": true }, "parentCategory": { "$ref": "#/components/schemas/Order_Category" } }, "additionalProperties": false }, "Order_CollectionDetailsCurbsideRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "carInfoPd": { "type": "object", "properties": { "registrationNumber": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" } } } } } }, "example": { "collectionDetails": { "type": "curbside", "carInfoPd": { "registrationNumber": "ABC123", "color": "blue", "description": "volvo" } } } }, "Order_CollectionDetailsDeliveryRequeset": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "deliveryAddressPd": { "type": "object", "properties": { "building": { "type": "string" }, "street": { "type": "string" }, "floorlevel": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" } } } } } }, "example": { "collectionDetails": { "type": "delivery", "deliveryAddressPd": { "building": "A", "street": "Secret street", "floorlevel": "2", "postalCode": "123 54", "city": "Stockholm" } } } }, "Order_CollectionDetailsDriveThruRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" } } } }, "example": { "collectionDetails": { "type": "driveThru" } } }, "Order_CollectionDetailsPickupLockerRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "pincode": { "type": "string" } } } }, "example": { "collectionDetails": { "type": "pickupLocker", "pincode": "14567" } } }, "Order_CollectionDetailsPickupRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "pickupZone": { "type": "string" } } } }, "example": { "collectionDetails": { "type": "pickup", "pickupZone": "entrance" } } }, "Order_CollectionDetailsRoomServiceRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "roomName": { "type": "string" } } } }, "example": { "collectionDetails": { "type": "roomService", "roomName": "123" } } }, "Order_CollectionDetailsTableService": { "required": [ "type", "tableName" ], "type": "object", "properties": { "type": { "enum": [ "tableService" ], "type": "string", "description": "Should default to; table." }, "tableName": { "type": "string" } }, "additionalProperties": false }, "Order_CollectionDetailsTableServiceRequest": { "type": "object", "properties": { "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "tableName": { "type": "string" } } } }, "example": { "collectionDetails": { "type": "tableService", "tableName": "string" } } }, "Order_CreateDealCommand": { "title": "CreateDealCommand", "type": "object", "properties": { "visibility": { "$ref": "#/components/schemas/Order_DealVisibility" }, "orderVersionId": { "type": "string", "description": "Describes for which version of the order this deal is created for" }, "title": { "$ref": "#/components/schemas/Order_Title" }, "description": { "$ref": "#/components/schemas/Order_Description" }, "name": { "type": "string", "description": "Name of the deal" }, "code": { "type": "string", "description": "A discount code that deal is connected to" }, "key": { "type": "string", "description": "Key of the deal that implies who is responsible for the deal" }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "description": "All discounts connected to this deal" }, "images": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Order_ImageReference" }, "description": "Reference to an image of the deal, will be shown in frontend", "nullable": true } }, "additionalProperties": false }, "Order_CreateDealForOrder": { "title": "CreateOrderScopedDealRequest", "type": "object", "properties": { "visibility": { "$ref": "#/components/schemas/Order_DealVisibility" }, "orderVersionId": { "type": "string", "description": "Describes for which version of the order this deal is created for." }, "title": { "$ref": "#/components/schemas/Order_Title" }, "description": { "$ref": "#/components/schemas/Order_Description" }, "name": { "type": "string", "description": "Internal name" }, "key": { "type": "string", "description": "A key that implies who is responsible for the deal" }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "description": "All discounts connected for this deal", "nullable": true }, "images": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Order_ImageReference" }, "nullable": true } }, "additionalProperties": false }, "Order_CreateDealResult": { "type": "object", "properties": { "statusCode": { "type": "string" }, "dealId": { "type": "string" }, "message": { "type": "string" }, "innerCode": { "type": "string" }, "successful": { "type": "boolean" }, "outerCode": { "type": "integer" } } }, "Order_DealPatchRequest": { "type": "object", "properties": { "code": { "type": "string", "description": "A discount code that deal is connected to" }, "discounts": { "type": "array", "items": { "required": [ "title", "createDate", "relatedItemIds", "relatedItemUnitIds", "dealId", "amounts", "mappingDetails" ], "type": "object", "properties": { "title": { "type": "object", "properties": { "translations": { "type": "object", "properties": { "en-GB": { "type": "string" }, "default": { "type": "string" } } } } }, "createDate": { "type": "string", "description": "ISO8601 timestamp of deal creation" }, "relatedItemIds": { "type": "array", "items": { "type": "string" }, "description": "Item Ids related to this discount" }, "relatedItemUnitIds": { "type": "array", "items": { "type": "string" }, "description": "Item Unit Ids related to this discount" }, "dealId": { "type": "string", "description": "Id of deal which this discount is connected to" }, "amounts": { "type": "array", "items": { "required": [ "discountedItemId", "discountedItemUnitId", "amount", "vat" ], "type": "object", "properties": { "discountedItemId": { "type": "string", "description": "Identifies which item in items[] that has been discounted" }, "discountedItemUnitId": { "type": "string", "description": "Identifies which item unit that has been discounted" }, "amount": { "type": "integer", "description": "Discounted amount in lowest monetary unit" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "number" } } }, "description": "Which VAT has been affected by this discount. Values in this array must exist in the VAT array of the discounted item" } } }, "description": "All item units thats been discounted" }, "mappingDetails": { "type": "object", "properties": { "externalDiscountId": { "type": "string" }, "myInfo": { "type": "object", "properties": { "foo": { "type": "string" }, "baz": { "type": "string" } } } } } } }, "description": "Discounts to apply for this deal" }, "isReserved": { "type": "boolean", "description": "Describes that the action reserve will be perfomred" }, "isFulfilled": { "type": "boolean", "description": "Describes that the action fulfilled will be performed" }, "isCaptured": { "type": "boolean", "description": "Describes that the action capture will be perfomred" }, "isAnnulled": { "type": "boolean", "description": "Describes that the action annulled will be perfomred" }, "title": { "type": "object", "properties": { "translations": { "type": "object", "properties": { "en-GB": { "type": "string" }, "default": { "type": "string" } } } } }, "description": { "type": "object", "properties": { "translations": { "type": "object", "properties": { "en-GB": { "type": "string" }, "default": { "type": "string" } } } } }, "name": { "type": "string", "description": "Internal name" }, "key": { "type": "string", "description": "A key that implies who is responsible for the deal" }, "images": {}, "orderVersionId": { "type": "string", "description": "Describes for which version of the order this deal is valid for." } } }, "Order_DealPatchResponse": { "type": "object", "properties": { "statusCode": { "type": "string" }, "message": { "type": "string" }, "innerCode": {}, "successful": { "type": "boolean" }, "outerCode": { "type": "integer" } } }, "Order_DealVisibility": { "enum": [ "notShown", "showAsOwnLine" ], "type": "string", "description": "Describes how the deal should be shown in UI", "example": "notShown" }, "Order_Description": { "type": "object", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false, "example": { "translations": { "default": "default translation", "en-GB": "British English translation" } } }, "Order_Desired": { "type": "object", "properties": { "isNegated": { "type": "boolean" } }, "additionalProperties": false }, "Order_Discount": { "required": [ "dealId", "title", "quantity", "relatedItemIds", "relatedItemUnitIds", "amounts", "postVat" ], "type": "object", "properties": { "dealId": { "type": "string", "description": "DealId of the deal that this discount is connected to" }, "title": { "type": "string", "description": "Title of the discount that will be shown in UI. Should be in the same culture as the order" }, "quantity": { "type": "integer", "description": "Quantity of discounts of this type", "format": "int32" }, "relatedItemIds": { "type": "array", "items": { "type": "string" }, "description": "Item Ids related to this discount" }, "relatedProductIds": { "type": "array", "items": { "type": "string" }, "deprecated": true }, "relatedItemUnitIds": { "type": "array", "items": { "type": "string" }, "description": "Item Unit Ids related to this discount" }, "relatedProductUnitIds": { "type": "array", "items": { "type": "string" }, "deprecated": true }, "amounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_DiscountAmount" }, "nullable": true }, "postVat": { "type": "boolean", "description": "Describes if the discount should be applied on gross (true) or net (false) price" } }, "additionalProperties": false }, "Order_DiscountAmount": { "type": "object", "properties": { "discountedItemId": { "type": "string", "description": "Which item that is affected by this amount." }, "discountedProductId": { "type": "string", "deprecated": true }, "discountedItemUnitId": { "type": "string", "description": "Which itemUnit that is affected by this amount." }, "discountedProductUnitId": { "type": "string", "deprecated": true }, "amount": { "type": "integer", "description": "The discounted amount in lowest monetary unit", "format": "int64" }, "vat": { "type": "array", "items": { "$ref": "#/components/schemas/Order_OrderVat" }, "description": "Which VAT that is affected by this discountAmount" } }, "additionalProperties": false }, "Order_Email_request": { "type": "object", "properties": { "email": { "type": "string" } }, "x-apim-schema-name": "Email request" }, "Order_ErrorInfo": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": {}, "nullable": true }, "innerError": { "$ref": "#/components/schemas/Order_ErrorInfo" } }, "additionalProperties": false }, "Order_ErrorInfoResponse": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "additionalProp1": { "type": "array", "items": { "type": "string" } }, "additionalProp2": { "type": "array", "items": { "type": "string" } }, "additionalProp3": { "type": "array", "items": { "type": "string" } } } }, "innerError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } }, "innerError": { "type": "string" } } }, "statusCode": { "type": "string" }, "innerCode": { "type": "string" }, "outerCode": { "type": "integer" } } }, "Order_Extension": { "type": "object", "additionalProperties": { "type": "string" } }, "Order_extensions": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "object", "properties": { "someId": { "type": "string" }, "myInfo": { "type": "object", "properties": { "foo": { "type": "string" }, "baz": { "type": "string" } } } } } } }, "Order_FetchDealsForOrder": { "title": "FetchDealsForOrder", "type": "object", "properties": { "deals": { "type": "array", "items": { "$ref": "#/components/schemas/Order_OrderDeal" } } }, "additionalProperties": false }, "Order_Image": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "extension": { "type": "string" } }, "additionalProperties": false }, "Order_ImageReference": { "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/Order_Image" } }, "additionalProperties": false }, "Order_Item": { "type": "object", "properties": { "subItemType": { "type": "string", "items": { "$ref": "#/components/schemas/Order_SubItemType" }, "description": "If the item has any subItemType. Default value is None. " }, "isContainer": { "type": "boolean" }, "type": { "type": "string", "items": { "$ref": "#/components/schemas/Order_ItemType" }, "description": "Type of item" }, "createDate": { "type": "string", "description": "ISO8601" }, "lastModified": { "type": "string", "description": "ISO8601" }, "menuItemId": { "type": "string", "description": "It item is a menuItem the menuItemId is required" }, "title": { "type": "string", "description": "Title of the item in the culture code of the order" }, "quantity": { "type": "integer", "description": "Quantity for this item." }, "configItems": { "type": "array", "items": { "required": [ "subItemType", "isContainer", "type", "createDate", "lastModified", "menuItemId", "title", "quantity", "configItems", "id", "unitIds" ], "type": "object", "properties": { "subItemType": { "type": "string" }, "isContainer": { "type": "boolean" }, "type": { "type": "string" }, "createDate": { "type": "string" }, "lastModified": { "type": "string" }, "menuItemId": { "type": "string" }, "title": { "type": "string" }, "quantity": { "type": "integer", "description": "Quantity for this configItem itself. Parent quantity not included. If this quantity = 2 and parent quantity = 3 - total number of configItems of this type will be 2*3" }, "configItems": { "type": "array", "items": { "required": [ "subItemType", "isContainer", "type", "createDate", "lastModified", "menuItemId", "title", "quantity", "configItems", "price", "id", "unitIds", "mappingDetails" ], "type": "object", "properties": { "subItemType": { "type": "string" }, "isContainer": { "type": "boolean" }, "type": { "type": "string" }, "createDate": { "type": "string" }, "lastModified": { "type": "string" }, "menuItemId": { "type": "string" }, "title": { "type": "string" }, "quantity": { "type": "integer" }, "configItems": { "type": "array", "items": { "required": [ "subItemType", "isContainer", "type", "createDate", "lastModified", "menuItemId", "title", "quantity", "configItems", "id", "unitIds", "mappingDetails" ], "type": "object", "properties": { "subItemType": { "type": "string" }, "isContainer": { "type": "boolean" }, "type": { "type": "string" }, "createDate": { "type": "string" }, "lastModified": { "type": "string" }, "menuItemId": { "type": "string" }, "title": { "type": "string" }, "quantity": { "type": "integer" }, "configItems": { "type": "array" }, "id": { "type": "string" }, "unitIds": { "type": "object", "properties": { "eec21340-eae0-41ae-bcba-4c8d05456c68.0": { "type": "array", "items": { "type": "string" } } } }, "mappingDetails": { "type": "object", "properties": { "stsId": { "type": "integer" }, "definitionSequence": { "type": "integer" }, "isVirtualProduct": { "type": "boolean" } } }, "uiProperties": { "type": "object", "properties": { "desired": { "type": "object", "properties": { "isNegated": { "type": "boolean" } } } } } } } }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "id": { "type": "string" }, "unitIds": { "type": "object", "properties": { "2de998af-23e6-494f-8a70-2802023507cc.0": { "type": "array", "items": { "type": "string" } } } }, "mappingDetails": { "type": "object", "properties": { "stsId": { "type": "integer" }, "definitionSequence": { "type": "integer" }, "isVirtualProduct": { "type": "boolean" } } } } } }, "id": { "type": "string" }, "unitIds": { "type": "object", "properties": { "f7780d6d-8d4f-4542-81ec-2fa89e9a73a9.0": { "type": "array", "items": { "type": "string" } } } }, "mappingDetails": { "type": "object", "properties": { "stsId": { "type": "integer" }, "definitionSequence": { "type": "integer" }, "isVirtualProduct": { "type": "boolean" } } } } }, "description": "Configurables for this item" }, "price": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "id": { "type": "string" }, "unitIds": { "type": "object", "properties": { "f7780d6d-8d4f-4542-81ec-2fa89e9a73a9": { "type": "array", "items": { "type": "string" } } } }, "context": { "type": "object", "properties": { "categoryId": { "type": "string" }, "type": { "type": "string" } } } } }, "Order_ItemType": { "enum": [ "menuItem", "chargeItem" ], "type": "string" }, "Order_Order": { "required": [ "versionId", "orderId", "storeId", "createDate", "lastModified", "orderTypeId", "salesChannel", "collectionDetails", "cultureCode", "userId", "payments", "products", "items", "currencyIsoCode", "currencyDecimalDigits", "mainEventsHistory", "readyTime" ], "type": "object", "properties": { "versionId": { "type": "string" }, "orderId": { "type": "string" }, "storeId": { "type": "string", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "orderRefsDict": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "lastModified": { "type": "string", "nullable": true, "readOnly": true }, "desiredReadyTime": { "type": "string", "format": "date-time", "deprecated": true }, "orderTypeId": { "type": "string", "nullable": true }, "salesChannel": { "$ref": "#/components/schemas/Order_SalesChannelExternal" }, "collectionDetails": { "$ref": "#/components/schemas/Order_CollectionDetailsTableService" }, "cultureCode": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Order_OrderPayment" }, "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Order_OrderItem" }, "nullable": true, "deprecated": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Item" }, "nullable": true }, "posData": { "$ref": "#/components/schemas/Order_OrderPosData" }, "readyTime": { "$ref": "#/components/schemas/Order_ReadyTime" }, "storeDetails": { "$ref": "#/components/schemas/Order_StoreDetails" }, "extensions": { "$ref": "#/components/schemas/Order_Extension" }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "nullable": true }, "currencyIsoCode": { "type": "string", "nullable": true }, "currencyDecimalDigits": { "type": "integer", "format": "int32" }, "mainEventsHistory": { "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true } }, "additionalProperties": false }, "Order_OrderDeal": { "type": "object", "properties": { "dealId": { "type": "string", "description": "Id of deal - same as id property" }, "title": { "$ref": "#/components/schemas/Order_Title" }, "description": { "$ref": "#/components/schemas/Order_Description" }, "name": { "type": "string", "description": "Internal name" }, "key": { "type": "string", "description": "A key that implies who is responsible for the deal" }, "images": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Order_ImageReference" }, "description": "Reference to an image of the deal" }, "orderVersionId": { "type": "string", "description": "Describes for which version of the order this deal is valid for." }, "createDate": { "type": "string", "description": "ISO8601 timestamp of deal creation", "format": "date-time" }, "visibility": { "$ref": "#/components/schemas/Order_DealVisibility" }, "id": { "type": "string", "description": "Id of deal - same as dealId property", "readOnly": true }, "code": { "type": "string", "description": "A discount code that the deal is connected to", "nullable": true }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "description": "Discounts for this deal" }, "orderId": { "type": "string", "description": "The order that deal is applied to" }, "status": { "$ref": "#/components/schemas/Order_Status" }, "isReserved": { "type": "boolean", "description": "Describes that the action reserve has been perfomred" }, "isFulfilled": { "type": "boolean", "description": "Describes that the action fulfilled has been performed" }, "isCaptured": { "type": "boolean", "description": "Describes that the action capture has been perfomred" }, "isAnnulled": { "type": "boolean", "description": "Describes that the action annulled has been perfomred" }, "isRefunded": { "type": "boolean", "description": "Describes that the action refunded has been perfomred" } }, "additionalProperties": false }, "Order_OrderDealPatchRequest": { "type": "object", "properties": { "code": { "type": "string", "description": "A discount code that deal is connected to", "nullable": true }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "description": "Discounts to apply for this deal", "nullable": true }, "isReserved": { "type": "boolean", "description": "Describes that the action reserve will be perfomred", "nullable": true }, "isFulfilled": { "type": "boolean", "description": "Describes that the action fulfilled will be performed", "nullable": true }, "isCaptured": { "type": "boolean", "description": "Describes that the action capture will be perfomred", "nullable": true }, "isAnnulled": { "type": "boolean", "description": "Describes that the action annulled will be perfomred", "nullable": true }, "title": { "$ref": "#/components/schemas/Order_Title" }, "description": { "$ref": "#/components/schemas/Order_Description" }, "name": { "type": "string", "description": "Internal name", "nullable": true }, "key": { "type": "string", "description": "A key that implies who is responsible for the deal", "nullable": true }, "images": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Order_ImageReference" }, "nullable": true }, "orderVersionId": { "type": "string", "description": "Describes for which version of the order this deal is valid for.", "nullable": true } }, "additionalProperties": false }, "Order_OrderItem": { "required": [ "createDate", "lastModified", "menuItemId", "type", "title", "quantity", "id", "unitIds" ], "type": "object", "properties": { "createDate": { "type": "string", "format": "date-time" }, "lastModified": { "type": "string", "format": "date-time" }, "menuItemId": { "type": "string" }, "type": { "$ref": "#/components/schemas/Order_OrderItemType" }, "title": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "configItems": { "type": "array", "items": { "$ref": "#/components/schemas/Order_OrderItem" }, "nullable": true }, "price": { "$ref": "#/components/schemas/Order_Price" }, "id": { "type": "string", "format": "uuid" }, "unitIds": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "uiProperties": { "$ref": "#/components/schemas/Order_UiProperties" } }, "additionalProperties": false }, "Order_OrderItemType": { "enum": [ "product", "container" ], "type": "string" }, "Order_OrderPayment": { "required": [ "transactionId", "amount", "paymentProviderReference", "paymentProviderId", "merchantId" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "transactionId": { "type": "string" }, "paymentProviderReference": { "type": "string", "nullable": true }, "paymentProviderId": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Order_OrderPosData": { "required": [ "datePlaced", "estimatedReadyTime", "orderName" ], "type": "object", "properties": { "orderName": { "type": "string" }, "estimatedReadyTime": { "type": "string", "format": "date-time" }, "datePlaced": { "type": "string", "format": "date-time" }, "cancelableUntil": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Order_OrderPosDataFailure": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } }, "innerError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } }, "innerError": { "type": "string" } } } } }, "Order_OrderVat": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "percent": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Order_PaymentMethodBankAccount": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "enum": [ "bankAccount" ], "type": "string", "format": "string", "example": "bankAccount" }, "accountInformation": { "$ref": "#/components/schemas/Order_BankAccountInformation" } }, "additionalProperties": false }, "Order_PaymentMethodMinimal": { "type": "object", "properties": { "name": { "type": "string", "description": "Should default to; deferred.", "example": "deferred" }, "type": { "enum": [ "minimal" ], "type": "string", "description": "Should default to; minimal." } }, "additionalProperties": false }, "Order_PaymentMethodPaymentCard": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "enum": [ "paymentCard" ], "type": "string", "format": "string", "example": "paymentCard" }, "cardInfo": { "$ref": "#/components/schemas/Order_Cardinfo" } }, "additionalProperties": false }, "Order_PosData": { "type": "object", "properties": { "orderName": { "type": "string" }, "estimatedReadyTime": { "type": "string" }, "datePlaced": { "type": "string" }, "cancelableUntil": { "type": "string" }, "orderRefsDict": { "type": "object", "properties": { "additionalProp1": { "type": "string" } } }, "extensions": { "type": "object", "properties": { "additionalProp1": { "type": "string" } } } } }, "Order_Price": { "required": [ "amount", "isVatIncluded" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "isVatIncluded": { "type": "boolean" }, "vat": { "$ref": "#/components/schemas/Order_OrderVat" } }, "additionalProperties": false }, "Order_ReadyTime": { "type": "object", "properties": { "readyTime": { "type": "object", "properties": { "desired": { "type": "string" }, "estimated": { "type": "string" } } } } }, "Order_Receipt": { "type": "object", "properties": { "orderId": { "type": "string" }, "userId": { "type": "string" }, "payments": { "type": "array", "items": { "required": [ "transactionId", "amount", "reference", "paymentProviderId", "paymentProviderReference", "paymentReference", "paymentMethod" ], "type": "object", "properties": { "transactionId": { "type": "string" }, "amount": { "type": "integer" }, "reference": { "type": "string" }, "paymentProviderId": { "type": "string" }, "paymentProviderReference": { "type": "string" }, "paymentReference": { "type": "string" }, "paymentMethod": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "accountInformation": { "type": "object", "properties": { "maskedAccountNumber": { "type": "string" }, "bankName": { "type": "string" } } } } } } } }, "lines": { "type": "array", "items": { "required": [ "title", "subItemType", "lineType", "lines", "linePrice", "totalPrice", "unitPrice", "quantity", "totalQuantity", "refs", "displayType" ], "type": "object", "properties": { "title": { "type": "string" }, "subItemType": { "type": "integer" }, "lineType": { "type": "string" }, "lines": { "type": "array", "items": { "type": "string" } }, "linePrice": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "totalPrice": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "unitPrice": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "quantity": { "type": "integer" }, "totalQuantity": { "type": "integer" }, "refs": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } }, "displayType": { "type": "string" } } } }, "itemsTotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "discountsTotal": { "type": "object", "properties": { "amount": { "type": "integer" }, "isVatIncluded": { "type": "boolean" }, "vat": { "type": "array", "items": { "required": [ "type", "percent" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" } } } } } }, "total": { "type": "object", "properties": { "gross": { "type": "integer" }, "net": { "type": "integer" }, "vat": { "type": "array", "items": { "required": [ "type", "percent", "amount", "basedOn" ], "type": "object", "properties": { "type": { "type": "string" }, "percent": { "type": "integer" }, "amount": { "type": "integer" }, "basedOn": { "type": "object", "properties": { "net": { "type": "integer" }, "gross": { "type": "integer" } } } } } } } }, "store": { "type": "object", "properties": { "storeId": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "object", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "buildingNumber": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "countryIsoCode": { "type": "string" } } }, "phoneNumber": { "type": "string" }, "tzdbTimeZoneId": { "type": "string" } } }, "posData": { "type": "object", "properties": { "orderName": { "type": "string" }, "estimatedReadyTime": { "type": "string" }, "cancelableUntil": { "type": "string" }, "datePlaced": { "type": "string" }, "receipt": { "type": "string" } } }, "collectionDetails": { "type": "object", "properties": { "type": { "type": "string" }, "carInfoPd": { "type": "object", "properties": { "registrationNumber": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string" } } } } }, "orderTypeId": { "type": "string" }, "currencyDecimalDigits": { "type": "integer" }, "currencyIsoCode": { "type": "string" }, "cultureCode": { "type": "string" }, "readyTime": { "type": "object", "properties": { "estimated": { "type": "string" } } }, "deliveryDropOffTime": { "type": "object", "properties": { "estimated": { "type": "string" } } }, "posCancellationData": { "type": "object", "properties": { "dateCanceled": { "type": "string" }, "receipt": { "type": "string" } } }, "deliveryRecipientPd": { "type": "object", "properties": { "phoneNumber": { "type": "string" }, "notes": { "type": "string" }, "name": { "type": "string" }, "courierFacingName": { "type": "string" }, "dropOffLocation": { "type": "object", "properties": { "position": { "type": "object", "properties": { "format": { "type": "string" }, "longitude": { "type": "string" }, "latitude": { "type": "string" } } }, "address": { "type": "object", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "buildingNumber": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "countryIsoCode": { "type": "string" } } } } } } } } }, "Order_RefundResult": { "type": "object", "properties": { "statusCode": { "$ref": "#/components/schemas/Order_StatusCode" }, "message": { "type": "string", "nullable": true }, "innerCode": { "type": "string", "nullable": true }, "successful": { "type": "boolean", "readOnly": true }, "outerCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Order_RegisterOrderItem": { "required": [ "menuItemId", "type", "quantity" ], "type": "object", "properties": { "menuItemId": { "type": "string" }, "registerOrderItemType": { "$ref": "#/components/schemas/Order_RegisterOrderItemType" }, "title": { "type": "string" }, "quantity": { "type": "integer" }, "configItems": { "type": "array", "items": { "$ref": "#/components/schemas/Order_RegisterOrderItem" }, "nullable": true }, "price": { "$ref": "#/components/schemas/Order_Price" }, "id": { "type": "string" }, "unitIds": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } } }, "Order_RegisterOrderItemType": { "enum": [ "container", "product" ], "type": "string", "default": "product" }, "Order_RegisterOrderPayment": { "required": [ "revenueCenterId", "paymentMethodId", "paymentProviderId", "amount", "paymentMethod", "paymentProviderReference" ], "type": "object", "properties": { "revenueCenterId": { "type": "string" }, "paymentMethodId": { "type": "string" }, "paymentProviderId": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int32" }, "paymentMethod": { "$ref": "#/components/schemas/Order_PaymentMethodMinimal" }, "paymentProviderReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Order_RegisterOrderRequest": { "required": [ "storeId", "orderTypeId", "salesChannel", "cultureCode", "currencyIsoCode", "products", "posData", "collectionDetails", "userId", "desiredCollectionTime", "merchantId", "isAlreadyPaid" ], "type": "object", "properties": { "storeId": { "type": "string" }, "orderTypeId": { "type": "string" }, "salesChannel": { "$ref": "#/components/schemas/Order_SalesChannelExternal" }, "cultureCode": { "type": "string" }, "currencyIsoCode": { "type": "string" }, "products": { "$ref": "#/components/schemas/Order_RegisterOrderItem" }, "posData": { "$ref": "#/components/schemas/Order_OrderPosData" }, "collectionDetails": { "$ref": "#/components/schemas/Order_CollectionDetailsTableService" }, "userId": { "type": "string" }, "extensions": { "$ref": "#/components/schemas/Order_Extension" }, "desiredReadyTime": { "type": "string", "format": "date-time" }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/Order_Discount" }, "description": "Discounts for this order", "nullable": true }, "isAlreadyPaid": { "type": "string", "description": "If set to false then payments must be included in RegisterOrderRequest" }, "merchantId": { "type": "string" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Order_RegisterOrderPayment" }, "description": "If isAlreadyPaid = false then this is required", "nullable": true } } }, "Order_RegisterOrderResponse": { "type": "object", "properties": { "orderId": { "type": "string" } } }, "Order_SalesChannelExternal": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "additionalProperties": { "type": "object", "additionalProperties": {}, "nullable": true }, "webClientVersion": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/Order_SalesChannelType" } }, "additionalProperties": false }, "Order_SalesChannelType": { "enum": [ "external" ], "type": "string", "default": "external" }, "Order_SetAllowCancelByCustomer": { "type": "object", "properties": { "allow": { "type": "boolean" } } }, "Order_SetOrderPriority": { "type": "object", "properties": { "orderPriority": { "type": "string" } } }, "Order_StartPaymentSession": { "type": "object", "properties": { "paymentSessionId": { "type": "string" } } }, "Order_StartPlaceOrderSession": { "type": "object", "properties": { "placeOrderSessionId": { "type": "string" } } }, "Order_Status": { "enum": [ "created", "reserved", "captured", "annulled", "refunded" ], "type": "string", "description": "Current status of the deal", "example": "created" }, "Order_StatusCode": { "enum": [ "successful", "conflict", "etagMissMatch", "notFound", "notAllowed", "badRequest", "unknown", "unauthorized", "forbidden", "canRetry", "noCode" ], "type": "string", "example": "successful" }, "Order_Steps": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "string" } } } }, "Order_StoreDetails": { "type": "object", "properties": { "storeDetails": { "type": "object", "properties": { "storeId": { "type": "string" }, "tzdbTimeZoneId": { "type": "string" }, "countryIsoCode": { "type": "string" }, "currencyDecimalDigits": { "type": "integer" }, "name": { "type": "string" } } } }, "example": { "storeDetails": { "storeId": "string", "tzdbTimeZoneId": "string", "countryIsoCode": "string", "currencyDecimalDigits": 0, "name": "string" } } }, "Order_SubItemType": { "enum": [ "none", "tip", "deliveryFee", "serviceCharge", "nonRevenueServiceCharge" ], "type": "string" }, "Order_Title": { "type": "object", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false, "example": { "translations": { "default": "default translation", "en-GB": "British English translation" } } }, "Order_TriggeredBy": { "type": "object", "properties": { "ItemId": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "nullable": true }, "parentCategory": { "$ref": "#/components/schemas/Order_Category" } }, "additionalProperties": false }, "Order_UiProperties": { "type": "object", "properties": { "desired": { "$ref": "#/components/schemas/Order_Desired" } }, "additionalProperties": false }, "Order_Workflows": { "type": "object", "properties": { "storeId": { "type": "string" }, "orderId": { "type": "string" }, "state": { "type": "object", "properties": { "state": { "type": "string" }, "changedAt": { "type": "string" }, "reason": { "type": "string" } } }, "completedSteps": { "type": "array", "items": { "required": [ "name", "trigger" ], "type": "object", "properties": { "name": { "type": "string" }, "trigger": { "type": "object", "properties": { "type": { "type": "string" }, "triggeredAt": { "type": "string" } } } } } }, "pendingSteps": { "type": "array", "items": { "required": [ "name", "triggers" ], "type": "object", "properties": { "name": { "type": "string" }, "triggers": { "type": "array", "items": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" }, "details": { "type": "object", "properties": { "delay": { "type": "string" }, "triggersAt": { "type": "string" } } } } } } } } } } }, "Device_device-status-error": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } }, "Device_Multiple_device_statuses_response": { "type": "object", "properties": { "devices": { "type": "object", "properties": { "deviceId1": { "type": "object", "properties": { "sourceType": { "type": "string" }, "deviceId": { "type": "string" }, "storeId": { "type": "string" }, "tenantId": { "type": "string" }, "modules": { "type": "array", "items": { "required": [ "moduleName", "heartbeatIsMissing", "heartbeatIsMissingSince", "subModules", "moduleStatuses", "sourceType", "warningLevel" ], "type": "object", "properties": { "moduleName": { "type": "string" }, "heartbeatIsMissing": { "type": "boolean" }, "heartbeatIsMissingSince": { "type": "string" }, "subModules": { "type": "array", "items": { "type": "string" } }, "moduleStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "sourceType": { "type": "string" }, "warningLevel": { "type": "integer" } } } }, "deviceStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "warningLevel": { "type": "integer" }, "createDate": { "type": "string" }, "deviceName": { "type": "string" } } }, "deviceId2": { "type": "object", "properties": { "sourceType": { "type": "string" }, "deviceId": { "type": "string" }, "storeId": { "type": "string" }, "tenantId": { "type": "string" }, "modules": { "type": "array", "items": { "required": [ "moduleName", "heartbeatIsMissing", "heartbeatIsMissingSince", "subModules", "moduleStatuses", "sourceType", "warningLevel" ], "type": "object", "properties": { "moduleName": { "type": "string" }, "heartbeatIsMissing": { "type": "boolean" }, "heartbeatIsMissingSince": { "type": "string" }, "subModules": { "type": "array", "items": { "type": "string" } }, "moduleStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "sourceType": { "type": "string" }, "warningLevel": { "type": "integer" } } } }, "deviceStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "warningLevel": { "type": "integer" }, "createDate": { "type": "string" }, "deviceName": { "type": "string" } } }, "deviceId3": { "type": "object", "properties": { "sourceType": { "type": "string" }, "deviceId": { "type": "string" }, "storeId": { "type": "string" }, "tenantId": { "type": "string" }, "modules": { "type": "array", "items": { "required": [ "moduleName", "heartbeatIsMissing", "heartbeatIsMissingSince", "subModules", "moduleStatuses", "sourceType", "warningLevel" ], "type": "object", "properties": { "moduleName": { "type": "string" }, "heartbeatIsMissing": { "type": "boolean" }, "heartbeatIsMissingSince": { "type": "string" }, "subModules": { "type": "array", "items": { "type": "string" } }, "moduleStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "sourceType": { "type": "string" }, "warningLevel": { "type": "integer" } } } }, "deviceStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "warningLevel": { "type": "integer" }, "createDate": { "type": "string" }, "deviceName": { "type": "string" } } } } } }, "x-apim-schema-name": "Multiple device statuses response" }, "Device_single-device-response": { "type": "object", "properties": { "sourceType": { "type": "string" }, "deviceId": { "type": "string" }, "storeId": { "type": "string" }, "tenantId": { "type": "string" }, "modules": { "type": "array", "items": { "required": [ "moduleName", "heartbeatIsMissing", "heartbeatIsMissingSince", "subModules", "moduleStatuses", "sourceType", "warningLevel" ], "type": "object", "properties": { "moduleName": { "type": "string" }, "heartbeatIsMissing": { "type": "boolean" }, "heartbeatIsMissingSince": { "type": "string" }, "subModules": { "type": "array", "items": { "type": "string" } }, "moduleStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "sourceType": { "type": "string" }, "warningLevel": { "type": "integer" } } } }, "deviceStatuses": { "type": "array", "items": { "required": [ "statusName", "statusValue", "warningLevel", "statusId" ], "type": "object", "properties": { "statusName": { "type": "string" }, "statusValue": { "type": "string" }, "warningLevel": { "type": "integer" }, "statusId": { "type": "string" } } } }, "warningLevel": { "type": "integer" }, "createDate": { "type": "string" }, "deviceName": { "type": "string" } } }, "Device_status-overview-minimal-response": { "type": "object", "properties": { "devices": { "type": "array", "items": { "required": [ "warningLevel", "deviceId", "storeId" ], "type": "object", "properties": { "warningLevel": { "type": "integer" }, "deviceId": { "type": "string" }, "storeId": { "type": "string" } } } } } }, "BusinessRule_GetAllRulesResponse": { "type": "object", "properties": { "rules": { "type": "array", "items": { "required": [ "comment", "recommendations", "filter", "activeDuring", "lastModified", "type", "id", "executionIndex" ], "type": "object", "properties": { "comment": { "type": "string" }, "recommendations": { "type": "object", "properties": { "triggerEvent": { "type": "string" }, "shownOnPage": { "type": "integer" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "ifInBasket": { "type": "string" } } }, "filter": { "type": "object", "properties": { "products": { "type": "object", "properties": { "appliesTo": { "type": "string" } } }, "categories": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "stores": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "storeCountryIsoCodes": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "orderClasses": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "daysOfWeek": { "type": "object", "properties": { "appliesTo": { "type": "string" } } } } }, "activeDuring": { "type": "object", "properties": { "timeOfDay": { "type": "object", "properties": { "applies": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" } } }, "dates": { "type": "object", "properties": { "applies": { "type": "string" } } } } }, "lastModified": { "type": "object", "properties": { "timestamp": { "type": "string" }, "by": { "type": "string" } } }, "type": { "type": "string" }, "id": { "type": "string" }, "executionIndex": { "type": "integer" } } } } } }, "BusinessRule_RuleRequestModel": { "required": [ "type", "comment", "executionIndex" ], "type": "object", "properties": { "comment": { "type": "string" }, "recommendations": { "type": "object", "properties": { "triggerEvent": { "type": "string" }, "shownOnPage": { "type": "integer" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "ifInBasket": { "type": "string" } } }, "filter": { "type": "object", "properties": { "products": { "type": "object", "properties": { "appliesTo": { "type": "string" } } }, "categories": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "stores": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "storeCountryIsoCodes": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "orderClasses": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "daysOfWeek": { "type": "object", "properties": { "appliesTo": { "type": "string" } } } } }, "activeDuring": { "type": "object", "properties": { "timeOfDay": { "type": "object", "properties": { "applies": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" } } }, "dates": { "type": "object", "properties": { "applies": { "type": "string" } } } } }, "lastModified": { "type": "object", "properties": { "timestamp": { "type": "string" }, "by": { "type": "string" } } }, "type": { "type": "string" }, "id": { "type": "string" }, "executionIndex": { "type": "integer" } }, "example": { "comment": "string", "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } }, "BusinessRule_upsellCategory": { "type": "object", "properties": { "comment": { "type": "string" }, "created": { "type": "object", "properties": { "timeStamp": { "type": "string" } } }, "recommendations": { "type": "object", "properties": { "triggerEvent": { "type": "string" }, "shownOnPage": { "type": "integer" }, "categoryIds": { "type": "array", "items": { "type": "integer" } }, "ifInBasket": { "type": "string" } } }, "filter": { "type": "object", "properties": { "products": { "type": "object", "properties": { "appliesTo": { "type": "string" } } }, "categories": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "stores": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "integer" } } } }, "storeCountryIsoCodes": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "orderClasses": { "type": "object", "properties": { "appliesTo": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "daysOfWeek": { "type": "object", "properties": { "appliesTo": { "type": "string" } } } } }, "activeDuring": { "type": "object", "properties": { "timeOfDay": { "type": "object", "properties": { "applies": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" } } }, "dates": { "type": "object", "properties": { "applies": { "type": "string" } } } } }, "lastModified": { "type": "object", "properties": { "timestamp": { "type": "string" }, "by": { "type": "string" } } }, "type": { "type": "string" }, "id": { "type": "string" }, "executionIndex": { "type": "integer" } }, "example": { "comment": "string", "created": { "timeStamp": "string" }, "recommendations": { "triggerEvent": "string", "shownOnPage": 0, "categoryIds": [ 0 ], "ifInBasket": "string" }, "filter": { "products": { "appliesTo": "string" }, "categories": { "appliesTo": "string", "values": [ 0 ] }, "stores": { "appliesTo": "string", "values": [ 0 ] }, "storeCountryIsoCodes": { "appliesTo": "string", "values": [ "string" ] }, "orderClasses": { "appliesTo": "string", "values": [ "string" ] }, "daysOfWeek": { "appliesTo": "string" } }, "activeDuring": { "timeOfDay": { "applies": "string", "startTime": "string", "endTime": "string" }, "dates": { "applies": "string" } }, "lastModified": { "timestamp": "string", "by": "string" }, "type": "string", "id": "string", "executionIndex": 0 } }, "Store_ErrorInfo": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "additionalProp1": { "type": "object" }, "additionalProp2": { "type": "object" }, "additionalProp3": { "type": "object" } } }, "innerError": { "type": "string" } } }, "Store_GET200ValueById": { "type": "object", "properties": { "additionalProp1": { "type": "object" }, "additionalProp2": { "type": "object" }, "additionalProp3": { "type": "object" } } }, "Store_GET200Values": { "type": "array", "items": { "required": [ "id", "version", "availability", "refs", "draft", "deleted", "lastUpdateDate" ], "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "integer" }, "availability": { "type": "string" }, "refs": { "type": "array", "items": { "type": "string" } }, "draft": { "type": "boolean" }, "deleted": { "type": "boolean" }, "lastUpdateDate": { "type": "object" } } } }, "User_Bad_Request": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Bad Request" }, "User_Communication_Preference_Not_Found": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Communication Preference Not Found" }, "User_Forbidden": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } } }, "User_Internal_Server_Error": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Internal Server Error" }, "User_Not_authorized": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Not authorized" }, "User_Not_Found": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Not Found" }, "User_Not_Implemented": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } }, "x-apim-schema-name": "Not Implemented" }, "User_SendEmail": { "type": "object", "properties": { "intent": { "type": "string" }, "content": { "type": "object", "properties": { "serviceType": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" } } } }, "example": { "intent": "TermsOfServiceUpdate1", "content": { "serviceType": "Email", "subject": "New policy", "body": "

This is our new policy update

" }, "countryCode": "US", "communicationReason": { "key": "news" } } }, "User_SendPush": { "type": "object", "properties": { "intent": { "type": "string" }, "content": { "type": "object", "properties": { "serviceType": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" } } } }, "example": { "intent": "TermsOfServiceUpdate1", "content": { "serviceType": "Push", "title": "Hi", "message": "This is our new policy update", "url": "https://www.futureordering.com" }, "countryCode": "US", "communicationReason": { "key": "news" } } }, "User_SendSms": { "type": "object", "properties": { "intent": { "type": "string" }, "content": { "type": "object", "properties": { "serviceType": { "type": "string" }, "message": { "type": "string" } } } }, "example": { "intent": "TermsOfServiceUpdate1", "content": { "serviceType": "SMS", "message": "This is our new policy update" }, "countryCode": "US", "communicationReason": { "key": "news" } } }, "User_Supported_communication_method": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "example": { "isActive": true }, "x-apim-schema-name": "Supported communication method" }, "User_Unathorized": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } } }, "User_Unauthorized": { "type": "object", "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title", "status" ], "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" } } } } } }, "User_Update_User_Communication_Preferences_Response": { "type": "object", "properties": { "key": { "type": "string" }, "supportedCommunicationMethods": { "type": "array", "items": { "required": [ "key", "isActive" ], "type": "object", "properties": { "key": { "type": "string" }, "isActive": { "type": "boolean" } } } } }, "x-apim-schema-name": "Update User Communication Preferences Response" }, "User_Update_User_Payload": { "type": "object", "properties": { "email": { "type": "string" }, "mobilePhoneNumber": { "type": "string" }, "name": { "type": "string" }, "friendlyName": { "type": "string" }, "emailVerified": { "type": "boolean" }, "mobilePhoneNumberVerified": { "type": "boolean" } }, "additionalProperties": false, "x-apim-schema-name": "Update User Payload" }, "User_Update_User_Request": { "type": "object", "properties": { "email": { "type": "string" }, "mobilePhoneNumber": { "type": "string" }, "name": { "type": "string" }, "friendlyName": { "type": "string" } }, "additionalProperties": false, "example": { "email": "email@example.com", "mobilePhoneNumber": "+4623123123", "name": "Firstname Lastname", "friendlyName": "Firstname" }, "x-apim-schema-name": "Update User Request" }, "User_Update_User_Verifications_payload": { "type": "object", "properties": { "email": { "type": "boolean" }, "mobilePhoneNumber": { "type": "boolean" } }, "example": { "email": true, "mobilePhoneNumber": true }, "x-apim-schema-name": "Update User Verifications payload" }, "User_User_Preferences_Communications_Update": { "type": "object", "properties": { "communicationReasons": { "type": "array", "items": { "required": [ "key", "supportedCommunicationMethods" ], "type": "object", "properties": { "key": { "type": "string" }, "supportedCommunicationMethods": { "type": "array", "items": { "required": [ "key", "isActive" ], "type": "object", "properties": { "key": { "type": "string" }, "isActive": { "type": "boolean" } } } } } } } }, "example": { "communicationReasons": [ { "key": "news", "supportedCommunicationMethods": [ { "key": "Push", "isActive": true } ] } ] }, "x-apim-schema-name": "User Preferences Communications Update" }, "User_User_Preference_Response": { "type": "object", "properties": { "communicationChannels": { "type": "array", "items": { "required": [ "type", "title", "description" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "object", "properties": { "value": { "type": "string" }, "translations": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } } } }, "description": { "type": "object", "properties": { "value": { "type": "string" }, "translations": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } } } } } } }, "communicationReasons": { "type": "array", "items": { "required": [ "key", "title", "description", "supportedCommunicationMethods" ], "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "object", "properties": { "value": { "type": "string" }, "translations": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } } } }, "description": { "type": "object", "properties": { "value": { "type": "string" }, "translations": { "type": "object", "properties": { "additionalProp1": { "type": "string" }, "additionalProp2": { "type": "string" }, "additionalProp3": { "type": "string" } } } } }, "supportedCommunicationMethods": { "type": "array", "items": { "required": [ "key", "canBeOverridden", "isDefault", "isActive" ], "type": "object", "properties": { "key": { "type": "string" }, "canBeOverridden": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } } } } } } }, "userId": { "type": "string" }, "tenantId": { "type": "string" } }, "x-apim-schema-name": "User Preference Response" }, "User_User_Response": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "tenantId": { "type": "string" }, "userId": { "type": "string" }, "username": { "type": "string" }, "legacyAccountType": { "type": "string" }, "name": { "type": "string" }, "friendlyName": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "mobilePhoneNumber": { "type": "string" }, "mobilePhoneNumberVerified": { "type": "boolean" }, "userInformation": { "type": "object", "properties": { "postalCode": { "type": "object", "properties": { "value": { "type": "string" }, "verified": { "type": "boolean" } } }, "birthDate": { "type": "object", "properties": { "value": { "type": "string" }, "verified": { "type": "boolean" } } } } }, "localLogin": { "type": "object", "properties": { "username": { "type": "string" } } }, "externalLogins": { "type": "array" }, "deviceLogins": { "type": "array" }, "permissionGroups": { "type": "array", "items": { "type": "string" } }, "createdAtUtc": { "type": "string" }, "lastTokenIssuedAtUtc": { "type": "string" }, "lastLoginDateUtc": { "type": "string" }, "deletionRequestedAtUtc": { "type": "string" }, "disabledAtUtc": { "type": "string" } }, "x-apim-schema-name": "User Response" }, "User_User_Response__list_": { "type": "array", "items": { "type": "object", "properties": { "disabled": { "type": "boolean" }, "tenantId": { "type": "string" }, "userId": { "type": "string" }, "username": { "type": "string" }, "legacyAccountType": { "type": "string" }, "name": { "type": "string" }, "friendlyName": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "mobilePhoneNumber": { "type": "string" }, "mobilePhoneNumberVerified": { "type": "boolean" }, "userInformation": { "type": "object", "properties": { "postalCode": { "type": "object", "properties": { "value": { "type": "string" }, "verified": { "type": "boolean" } } }, "birthDate": { "type": "object", "properties": { "value": { "type": "string" }, "verified": { "type": "boolean" } } } } }, "localLogin": { "type": "object", "properties": { "username": { "type": "string" } } }, "externalLogins": { "type": "array" }, "deviceLogins": { "type": "array" }, "permissionGroups": { "type": "array", "items": { "type": "string" } }, "createdAtUtc": { "type": "string" }, "lastTokenIssuedAtUtc": { "type": "string" }, "lastLoginDateUtc": { "type": "string" }, "deletionRequestedAtUtc": { "type": "string" }, "disabledAtUtc": { "type": "string" } } }, "x-apim-schema-name": "User Response (list)" } } }, "tags": [ { "name": "Devices" }, { "name": "Entities" }, { "name": "Order Workflows" }, { "name": "Frontend Plugins" }, { "name": "Stores" }, { "name": "Communication Preferences" }, { "name": "Orders" }, { "name": "Master Data Orchestrations" }, { "name": "Custom Payment Provider" }, { "name": "Business Rules" }, { "name": "Users" }, { "name": "Deals" } ], "x-tagGroups": [ { "tags": [ "Orders", "Deals", "Order Workflows" ], "name": "Order Management" }, { "tags": [ "Business Rules", "Entities", "Master Data Orchestrations", "Stores" ], "name": "Configuration & Master Data" }, { "tags": [ "Frontend Plugins" ], "name": "Frontend" }, { "tags": [ "Devices" ], "name": "Devices" }, { "tags": [ "Users", "Communication Preferences" ], "name": "User Management" }, { "tags": [ "Custom Payment Provider" ], "name": "Payment" } ] }