{ "openapi": "3.0.4", "info": { "title": "Public core API", "description": "# Getting started\n\n## Access token\nAll requests to the API must include a access token in header to be authorized.\n\nFollow the get started to get a access token https://ancon.dev/get-started/.\n\nThe header must be named 'Access-Token' and have a valid token value otherwise a 401 Unauthorized repsonse is given.\n\n## Token levels\nAccess tokens has two levels it can be.\n\n### Tenant level\nTenant level tokens have read/write permissions on all endpoints.\n\n### Outlet level\nOutlet level tokens can only has read permissions on tenant level data and read/write on outlet level data for the specified outlet the token was created for.\n\n## First requests\nStart off by getting tenant details look at Tenant -> Get tenant details endpoint, as it requires no input you will get back information about the tenant your token is connected to.\n\nThe tenantId retrved here will be required in many subsequent endpoints urls.\n\nContinue with getting the outlet list look at Tenant -> Get outlet list endpoint, it also does not required any input and will get back all outlets under the tenant (Outlet level tokens will only get the one outlet connected)\n\n## Request limits\nRequest limit information is send back in response headers:\n\n* X-Rate-Limit-Limit: 1s\n* X-Rate-Limit-Remaining: 9\n* X-Rate-Limit-Reset: 2022-12-16T14:13:28.6783785Z\n\nIn this example the endpoint allows for max 10 requests each second.\n\n## Correlation-Id\n\nCorrelation id is a unique id of the request and is sent back as a response header, include this in any question or bugreport you make.\n\nCan also be sent in as a request header to correlate any logging you may do on your side then the sent in correlation id will be used in our logging aswell.\n\nSent in as 'x-correlation-id' with a string value, best to use guid/uuid.\n\n## Filtering\nFiltering is done with query parameters, and available properties that can be filtered on is documented per endpoint.\n\nFiltering specification: https://ancon.dev/wp-content/uploads/2022/12/Filtering-2022-12-16.pdf\n\n## Deprecation of endpoints\nEndpoints can be deprecated because a newer version is added and the existing will eventually expire out from the api.\n\nIf a endpoint is deprecated it will be shown here in the documentation.\n\nIt is also included in response headers:\n* Deprecation-Sunset: 2024-10-01 00:00:00\n* Deprecation: This API endpoint is deprecated and will be removed in a future version, use a newer version.\n\nIt is recomended to implement alerting on this so you can get notified if you're using a deprecated endpont version to avoid any disruptions.\n\n## Check endpoints V2\nA new generation of the Check endpoints is available under api/v2 (same paths, version segment v2). They return the modern check model and honor the Accept-Language request header for localized product names.\n\nThe api/v1 Check endpoints are deprecated with a sunset date of 2028-09-01, migrate to the api/v2 endpoints before then.\n\n# Webhooks\nWebhooks are found in https://cloud.ancon.io on the integration page for public api, webhooks will be sent out once a url is configured there.\n\nUpon failures we will try to send out the webhook for max 3 tries with 3 minutes between.\n\nAll webhooks will be sent with headers:\n\n* Api-Version: 1.0\n* Try: 1\n* MaxTries: 3\n\n## Checks\nCheck Created:\nroot contains:\n\n* checkId\n\nCheck Paid:\nroot contains:\n\n* checkId\n\nCheck Fully Paid:\nroot contains:\n\n* checkId\n\n* orderId\n\n## Orders\nOrder created: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Orders/paths/~1public~1api~1v1~1Outlets~1%7BoutletId%7D~1Orders~1%7Bid%7D/get)\n\nOrder refunded: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Orders/paths/~1public~1api~1v1~1Outlets~1%7BoutletId%7D~1Orders~1%7Bid%7D/get)\n\n## Products\nProduct created: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Products/paths/~1public~1api~1v1.1~1Tenants~1%7BtenantId%7D~1Products~1%7Bid%7D/get)\n\nProduct deleted: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Products/paths/~1public~1api~1v1.1~1Tenants~1%7BtenantId%7D~1Products~1%7Bid%7D/get)\n\nProduct updated: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Products/paths/~1public~1api~1v1.1~1Tenants~1%7BtenantId%7D~1Products~1%7Bid%7D/get)\n\n## Tickets\nTicket updated: [Webhook payload](https://core-api.ancon.io/docs-V1/index.html#tag/Tickets/paths/~1public~1api~1v1~1Outlets~1%7BoutletId%7D~1Tickets~1%7BticketId%7D/get)\n", "contact": { "name": "", "email": "integration-support@ancon.io" }, "version": "public-v1", "x-logo": { "url": "https://ancon.dev/wp-content/uploads/2022/12/logo-tango_L-no-transp.png" } }, "paths": { "/api/v1/Tenants/{tenantId}/AddOnGroups/{id}": { "get": { "tags": [ "AddOnGroups" ], "summary": "Get add on group details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.Detail.DetailAddOnGroupResponse" }, "example": { "addOnGroup": { "id": "33334e1f-e5fd-46fb-885b-843b591a3558", "tenantId": "0c3b3a4e-4156-4dc1-8f38-d7d85aedebe7", "name": "Sauces", "minimumAmount": 0.0, "maximumAmount": 5.0, "allowMultiple": true, "freeAmount": 0.0, "afterFreePrice": { "amount": 0.0, "currency": "SEK" }, "ingredients": [ { "id": "0c102870-27c8-4ce2-8f54-31d78b3d521c", "name": "Hot Sauce", "position": 0, "hasOwnPrice": false, "defaultPrice": { "amount": 20.0, "currency": "SEK" }, "price": { "amount": 0.0, "currency": "SEK" } }, { "id": "60189fe7-643d-4eef-9548-5e1efa18037c", "name": "BBQ Sauce", "position": 1, "hasOwnPrice": true, "defaultPrice": { "amount": 15.0, "currency": "SEK" }, "price": { "amount": 18.0, "currency": "SEK" } } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/AddOnGroups": { "get": { "tags": [ "AddOnGroups" ], "summary": "Get add on group list", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.List.ListAddOnGroupQueryResponse" }, "example": { "items": [ { "id": "a8c48abf-fa9f-4a33-a3b9-e9f15009e369", "name": "Add on group model name 1", "outletShares": [ { "id": "3a4085cc-a775-4615-ac45-f552ccdfe120", "name": "Outlet 1", "productShareType": 0 }, { "id": "5f51ecf9-ca08-40aa-9ce0-434421774f59", "name": "Outlet 2", "productShareType": 0 } ] }, { "id": "1a7c6607-d1bc-426b-8759-efbdffb98637", "name": "Add on group model name 2", "outletShares": [ { "id": "090aeb40-c482-4c6b-88c4-89dedc17b8e7", "name": "Outlet 3", "productShareType": 1 } ] } ], "meta": { "count": 2, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checkouts/{id}": { "get": { "tags": [ "Checkouts" ], "summary": "Get checkout details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Queries.Details.DetailCheckoutQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "delete": { "tags": [ "Checkouts" ], "summary": "Delete checkout", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checkouts": { "post": { "tags": [ "Checkouts" ], "summary": "Create checkout", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.Create.CreateCheckoutCommand" } ] }, "examples": { "Eat in": { "value": { "orderFormat": 2, "serviceTime": { "kind": 1, "time": "2026-10-23T20:33:34.041788Z" }, "delivery": null, "instructions": null, "salesLocation": { "salesLocationId": "3663d997-8aa5-4461-b9f8-e10a8e97a488", "type": 1 }, "items": [ { "variantId": "db7b8f1d-29ae-498e-8b96-03edb9b815dc", "quantity": 1, "modifications": [ { "modification": "Add", "ingredientId": "b03029bc-6a6b-4bc4-8603-67aa3d66522b", "addOnGroupId": "32076eea-716a-445b-bf25-8d7d41a6d88b", "replaceId": null, "quantity": 2.0, "freeAmount": 1.0 }, { "modification": "Add", "ingredientId": "47d9397b-13be-4e8e-9ec6-bc076752cb68", "addOnGroupId": "cb0d0a3b-bee5-4bf3-b9c0-be1eba3f3fab", "replaceId": null, "quantity": 1.0, "freeAmount": 0.0 } ] }, { "variantId": "1eebb990-084b-4dff-908c-76b12661fd32", "quantity": 2, "modifications": [ { "modification": "Remove", "ingredientId": "dd7446c1-9089-4aa7-a29f-3e69c0b77972", "addOnGroupId": null, "replaceId": null, "quantity": 0.0, "freeAmount": 0.0 }, { "modification": "Replace", "ingredientId": "8cfcf8b8-6474-4e93-a5a0-93599b43942e", "addOnGroupId": null, "replaceId": "9861a404-0eff-44f2-a755-b92bf27d07dc", "quantity": 1.0, "freeAmount": 0.0 } ] } ] } }, "Delivery": { "value": { "orderFormat": 8, "serviceTime": { "kind": 0, "time": null }, "delivery": { "address": { "street": "Kungliga slottet", "zipCode": "107 70", "city": "Stockholm", "state": null, "country": "Sweden", "location": { "latitude": 101.0, "longitude": 201.0 } }, "phone": "084026100", "recipient": "Head waiter" }, "instructions": "Enter the main doors and take the flight of stars to the left.", "salesLocation": { "salesLocationId": "f7e613bc-a264-4171-9bad-3a0c160d8bbe", "type": 1 }, "items": [ { "variantId": "1ae2594a-14dd-48e8-a8d6-013aa0c073f7", "quantity": 1, "modifications": [ { "modification": "Add", "ingredientId": "1a6a9c1c-a89d-40b5-80d6-4b38f237169d", "addOnGroupId": "5409ec61-03eb-4cea-899d-ed06ab136ce1", "replaceId": null, "quantity": 2.0, "freeAmount": 1.0 }, { "modification": "Add", "ingredientId": "ff3c48dd-b78a-4b8f-8162-eba4c5d44a23", "addOnGroupId": "70d3c43d-3716-4237-924a-cd77903c6496", "replaceId": null, "quantity": 1.0, "freeAmount": 0.0 } ] }, { "variantId": "0c3f91d4-2fc9-4f59-bed5-c9da9cdb0696", "quantity": 2, "modifications": [ { "modification": "Remove", "ingredientId": "3e5efaa6-a467-40af-b526-52eca86e281b", "addOnGroupId": null, "replaceId": null, "quantity": 0.0, "freeAmount": 0.0 }, { "modification": "Replace", "ingredientId": "9479e206-ba3e-4b77-8cae-0397a79fdad5", "addOnGroupId": null, "replaceId": "3798fe38-539c-4d83-b6d1-1d17ea54f6b3", "quantity": 1.0, "freeAmount": 0.0 } ] } ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.Create.CreateCheckoutCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checkouts/{id}/RecalculatePrice": { "put": { "tags": [ "Checkouts" ], "summary": "Recalculate checkout prices", "description": "Use this to recalculate product prices within the checkout, could be price presets based on time that can change if there is some time between creation and payment.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.RecalculatePrices.RecalculateCheckoutPricesCommandResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checkouts/{id}/ApplyDiscount": { "put": { "tags": [ "Checkouts" ], "summary": "Apply checkout discount", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ApplyDiscount.ApplyDiscountCheckoutCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ApplyDiscount.ApplyDiscountCheckoutCommandResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checkouts/{checkoutId}/Payments": { "post": { "tags": [ "Checkouts" ], "summary": "Create checkout payment.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkoutId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.PaymentCreateCompletedCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.PaymentCreateCompletedCommandResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}": { "get": { "tags": [ "Checks" ], "summary": "Get check details", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Details.DetailCheckQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Checks" ], "summary": "Delete check", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Delete.DeleteCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Delete.DeleteCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks": { "post": { "tags": [ "Checks" ], "summary": "Create check", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Create.CreateCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Create.CreateCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/Move": { "put": { "tags": [ "Checks" ], "summary": "Move check", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Move.MoveCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Move.MoveCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomName": { "put": { "tags": [ "Checks" ], "summary": "Update check custom name", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomName.UpdateCheckCustomNameCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomName.UpdateCheckCustomNameCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/CustomTicket": { "put": { "tags": [ "Checks" ], "summary": "Update check custom ticket number", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletid}/Checks/SalesLocations/{salesLocationId}": { "get": { "tags": [ "Checks" ], "summary": "Get check list for sales location", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "salesLocationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.SalesLocation.ListCheckSalesLocationQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletid}/Checks": { "get": { "tags": [ "Checks" ], "summary": "Get check list for outlet", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "MetaFilter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Outlets.ListCheckOutletQueryResponse" }, "example": { "items": [ { "id": "86520ea1-5e4f-4f34-adec-80ec23a8593a", "referenceNumber": 9012, "serialNumber": 5678, "ticketNumber": 1234, "customName": "Custom check name", "customTicketNumber": 123456789, "orderId": "5d8ed9a0-248e-4f4b-84f2-a85b456a59b1", "lingerWhenClosed": false, "groupId": "78094736-feb3-437c-a8a2-41bcfd49c78c", "metaData": [ { "id": "5e4590d3-dc0f-48c7-a517-0494f6ce7225", "created": "2026-10-23T09:33:34.0616728Z", "modified": "2026-10-23T10:33:34.0616739Z", "checkId": "86520ea1-5e4f-4f34-adec-80ec23a8593a", "checkItemId": null, "metaData": { "id": "00000000-0000-0000-0000-000000000000", "sms": null, "email": "example@email.com", "amount": 1000, "printQr": false, "sendingBy": "", "giftCardNumber": "0000000000", "draftGiftCardId": "00000000-0000-0000-0000-000000000000", "giftCardNumberType": 2 } } ], "position": 5678 } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/Discount": { "put": { "tags": [ "Checks" ], "summary": "Discount check", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Discount.DiscountCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/Items/Split": { "put": { "tags": [ "Checks" ], "summary": "Check item split", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItems.Commands.Split.SplitCheckItemCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItems.Commands.Split.SplitCheckItemCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/Split": { "put": { "tags": [ "Checks" ], "summary": "Split check", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Split.SplitCheckCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Split.SplitCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/Items/Discount": { "put": { "tags": [ "Checks" ], "summary": "Check item discount", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.DiscountCheckItemCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/AddItem": { "post": { "tags": [ "Checks" ], "summary": "Add item", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemCheckCommand" } ] }, "examples": { "Add item new check example": { "value": { "item": { "variantId": "ae324e8d-812e-490f-8ecd-8461daeb181c", "quantity": 1.0, "kitchenMessage": "Cut burger in half", "price": { "unitPrice": 0.0, "additionalPrice": 0.0 }, "upsellGroupId": "d5f5e3c3-101e-442a-9f42-98ec217bcebf", "modifications": [ { "modification": "Tomato", "ingredientId": "0ff65a9c-37bb-4cfb-91d3-9b13fad08284", "addOnGroupId": "182027d2-9a76-44fd-a3ec-56b7d6cbf667", "replaceId": "bf34dea4-4ced-476b-bc0b-1bc690e92c9d", "description": "Add tomato", "quantity": 1.0, "freeAmount": 0.0 } ], "tag": "Lunch special", "subProductSpecification": null }, "courseId": "d23a8d20-6379-4a48-a060-e7a2a05dde16", "checkId": null, "check": { "orderFormat": 1, "salesLocationType": 2, "salesLocationId": "b1c0f549-460e-4661-a9af-1253e80d276c", "guestCount": null, "collectionTicketId": null, "externalTableId": "External id" }, "isPrepaid": false } }, "Add item to existing check example": { "value": { "item": { "variantId": "bfebfbbb-3406-497f-9cd4-8f30c27c0240", "quantity": 2.0, "kitchenMessage": "Medium rare", "price": null, "upsellGroupId": "e95ec5c8-4410-4ef2-9282-4ecc586d1bec", "modifications": [ { "modification": "Sauce", "ingredientId": "6206579f-8f5d-4531-8424-e0ba6f31aa92", "addOnGroupId": "2cec320c-e235-497f-b3c6-7a1d674443f6", "replaceId": "ce4c2df5-0f2e-4712-b8aa-5d6d0034f9f0", "description": "Extra sauce", "quantity": 1.0, "freeAmount": 0.0 } ], "tag": "Dinner", "subProductSpecification": null }, "courseId": "72a7bfba-f65e-4b3a-bd6d-684f9491ed31", "checkId": "ed392e73-ddc6-4a8f-a44a-6c5f6ca4e22e", "check": null, "isPrepaid": false } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemCheckResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/TableReservationMetaData": { "put": { "tags": [ "Checks" ], "summary": "Set TableReservation check metadata", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommandResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Checks/{checkId}/IntegrationPayment": { "put": { "tags": [ "Checks" ], "summary": "Create integration check payment", "description": "Will no longer work after 2028-09-01 00:00, move over to the V2 Check endpoints instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommand" } ] }, "example": { "paymentAmount": { "amount": 100.0, "currencyCode": "SEK" }, "tipAmount": { "amount": 20.0, "currencyCode": "SEK" }, "externalReference": "ExternalReference1234", "externalTimeStamp": "2026-10-23T14:33:34.0729818Z" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommandResponse" }, "example": { "check": { "id": "0371ac47-97cc-4e54-98f1-61984ec16e71", "created": "2026-10-23T13:33:34.0725265Z", "modified": "2026-10-23T14:33:34.0725269Z", "outlet": { "id": "6bff8e17-4d8c-4236-ab5b-dc1c7088a8e6", "name": "Outlet name" }, "orderFormat": 1, "orderType": 0, "saleSourceId": "ac0a0ba0-87d9-4e7f-bd87-0b2cecc1729e", "discountValue": { "value": 0.10, "type": 0 }, "discountCode": { "discountId": "ef2ae75e-a56c-47e1-9f99-556226dc95aa", "discountName": "Discount name" }, "currency": { "code": "SEK" }, "salesLocation": { "salesLocationId": "66ff4ebb-22d5-4479-83cd-3b1784d0af0b", "type": 2 }, "companyInfo": { "companyId": "7154eb16-352d-4d88-a7f8-65c5ca61f215", "companyName": "Company", "companyBusinessNumber": "12345", "address": { "street": "Street", "street2": "Street2", "zipCode": "100 000", "city": "City" }, "invoiceEmail": { "email": "email@email.com" }, "memberId": "6a703830-641f-492a-8853-da327140b5bf", "memberName": "Member name" }, "deletedReason": null, "createdCheckTenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "createdCheckTenantUser": { "id": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "name": { "firstName": "First name", "lastName": "Last name" }, "email": { "email": "email@email.com" } }, "closedCheckTenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "createdCheckClientId": "94f31a9f-558c-41dd-8745-f16f68b059e6", "closedCheckClientId": "94f31a9f-558c-41dd-8745-f16f68b059e6", "orderId": "d5383b37-3d21-4338-8e3c-d584dfd89f2e", "incrementalNumbers": { "ticketNumber": 12345, "serialNumber": 123456, "referenceNumber": 1234567, "refundSerialNumber": null }, "collectionTicketId": null, "customTicketNumber": null, "customName": "Custom name", "deleted": null, "guestCount": 4, "metaData": [ ], "checkItems": [ { "id": "fb1fa060-65d4-4dc9-9ad7-5fc1f7a7fd05", "checkId": "0371ac47-97cc-4e54-98f1-61984ec16e71", "created": "2026-10-23T14:33:34.0724787Z", "modified": "2026-10-23T14:33:34.0724787Z", "product": { "glassesPerBottle": null, "hasVariants": false, "isSystemProduct": false, "localizedProductNames": null, "localizedVariantNames": null, "position": null, "productGroupId": "b10d2eb9-4192-452c-8239-9b373738434d", "productGroupName": "Food", "productId": "4dd288e1-67e8-471d-8bc1-331d986e63c1", "productName": "Baconburger", "productNumber": "1", "productType": 0, "storageInfo": null, "subProductId": null, "subProductQuantity": null, "useBasePrice": true, "variantId": "79ef22be-e697-4597-b2a5-d959e629da2e", "variantName": "180g", "variantNumber": "1", "variantType": 0 }, "quantity": { "value": 2.0 }, "unitQuantity": { "value": 1.0 }, "unit": { "name": "Unit", "type": 1 }, "pricePresetId": null, "productPriceInclTax": { "unitPrice": { "amount": 50.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productPriceExclTax": { "unitPrice": { "amount": 44.64285714285714285714285714, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productMaterialCostExclTax": { "unitPrice": { "amount": 25.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "kitchenMessage": "Extra sauce", "discountInfo": { "discountId": "1c943352-bc75-4d82-8876-b0fd4bbde98a", "discountName": "20% off burgers!" }, "discount": { "value": 0.20, "type": 0 }, "courseName": "Course name", "coursePosition": 1, "checkPaymentId": null, "paidAt": "2026-10-23T14:33:34.0724868Z", "tag": null, "status": 2, "upsellGroupId": null, "ticketedAt": "2026-10-23T14:33:34.0724871Z", "ticketedTenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "modifications": [ ], "isTaxMandatory": true, "taxes": [ { "id": "dc542ba1-f8c0-47a5-8493-55ef8c138804", "created": "2026-10-23T14:33:34.0724883Z", "modified": "2026-10-23T14:33:34.0724883Z", "tax": { "taxId": "6eccd3dd-3fcb-4e1f-9ffb-3d0a1d3b3fad", "taxValue": { "type": 1, "rate": 12.0 } } } ], "checkItems": [ ], "parentItemId": null, "isMultiproduct": false, "hasOwnPrice": true, "priceInclTax": { "amount": 80.00, "currency": "SEK" }, "priceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalPriceInclTax": { "amount": 80.00, "currency": "SEK" }, "totalPriceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalMaterialCostExclTax": { "amount": 50.0, "currency": "SEK" }, "discountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "discountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "totalDiscountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "totalDiscountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "modificationPriceInclTax": { "amount": 0.0, "currency": "SEK" }, "modificationPriceExclTax": { "amount": 0.0, "currency": "SEK" }, "isPrepaid": false } ], "payments": [ { "id": "6fafe0c4-f8f7-4f03-aae6-ac3b573cd7b2", "created": "2026-10-23T14:33:34.0724952Z", "modified": "2026-10-23T14:33:34.0724953Z", "paymentType": 1, "paymentMethod": { "id": "123", "type": 21, "displayName": null }, "amount": { "amount": 100.0, "currency": "SEK" }, "cashBackAmount": { "amount": 0.0, "currency": "SEK" }, "roundingAmount": { "amount": 0.0, "currency": "SEK" }, "tipAmount": { "amount": 50.0, "currency": "SEK" }, "tenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "externalReference": "External reference1234", "externalIdentifier": "External identifier", "externalTimeStamp": "2026-10-23T14:33:34.0724962Z", "status": 1, "errorType": null, "terminal": { "id": "730c1b7b-d5c1-4d2d-8811-6518b455c1d2", "name": "Terminal name" }, "client": { "id": "94f31a9f-558c-41dd-8745-f16f68b059e6", "name": "Pos name" }, "centralControlUnitSerial": "4444-2323-11233", "receipts": [ { "receiverType": 1, "needsSignature": false, "receiptTexts": [ { "key": "key", "value": "value", "name": "name" } ] } ], "invoiceReferenceNote": "Invoice reference note", "isReceiptPrinted": true } ], "allCheckItems": [ { "id": "fb1fa060-65d4-4dc9-9ad7-5fc1f7a7fd05", "checkId": "0371ac47-97cc-4e54-98f1-61984ec16e71", "created": "2026-10-23T14:33:34.0724787Z", "modified": "2026-10-23T14:33:34.0724787Z", "product": { "glassesPerBottle": null, "hasVariants": false, "isSystemProduct": false, "localizedProductNames": null, "localizedVariantNames": null, "position": null, "productGroupId": "b10d2eb9-4192-452c-8239-9b373738434d", "productGroupName": "Food", "productId": "4dd288e1-67e8-471d-8bc1-331d986e63c1", "productName": "Baconburger", "productNumber": "1", "productType": 0, "storageInfo": null, "subProductId": null, "subProductQuantity": null, "useBasePrice": true, "variantId": "79ef22be-e697-4597-b2a5-d959e629da2e", "variantName": "180g", "variantNumber": "1", "variantType": 0 }, "quantity": { "value": 2.0 }, "unitQuantity": { "value": 1.0 }, "unit": { "name": "Unit", "type": 1 }, "pricePresetId": null, "productPriceInclTax": { "unitPrice": { "amount": 50.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productPriceExclTax": { "unitPrice": { "amount": 44.64285714285714285714285714, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productMaterialCostExclTax": { "unitPrice": { "amount": 25.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "kitchenMessage": "Extra sauce", "discountInfo": { "discountId": "1c943352-bc75-4d82-8876-b0fd4bbde98a", "discountName": "20% off burgers!" }, "discount": { "value": 0.20, "type": 0 }, "courseName": "Course name", "coursePosition": 1, "checkPaymentId": null, "paidAt": "2026-10-23T14:33:34.0724868Z", "tag": null, "status": 2, "upsellGroupId": null, "ticketedAt": "2026-10-23T14:33:34.0724871Z", "ticketedTenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "modifications": [ ], "isTaxMandatory": true, "taxes": [ { "id": "dc542ba1-f8c0-47a5-8493-55ef8c138804", "created": "2026-10-23T14:33:34.0724883Z", "modified": "2026-10-23T14:33:34.0724883Z", "tax": { "taxId": "6eccd3dd-3fcb-4e1f-9ffb-3d0a1d3b3fad", "taxValue": { "type": 1, "rate": 12.0 } } } ], "checkItems": [ ], "parentItemId": null, "isMultiproduct": false, "hasOwnPrice": true, "priceInclTax": { "amount": 80.00, "currency": "SEK" }, "priceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalPriceInclTax": { "amount": 80.00, "currency": "SEK" }, "totalPriceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalMaterialCostExclTax": { "amount": 50.0, "currency": "SEK" }, "discountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "discountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "totalDiscountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "totalDiscountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "modificationPriceInclTax": { "amount": 0.0, "currency": "SEK" }, "modificationPriceExclTax": { "amount": 0.0, "currency": "SEK" }, "isPrepaid": false } ], "itemsExclSystemProducts": [ { "id": "fb1fa060-65d4-4dc9-9ad7-5fc1f7a7fd05", "checkId": "0371ac47-97cc-4e54-98f1-61984ec16e71", "created": "2026-10-23T14:33:34.0724787Z", "modified": "2026-10-23T14:33:34.0724787Z", "product": { "glassesPerBottle": null, "hasVariants": false, "isSystemProduct": false, "localizedProductNames": null, "localizedVariantNames": null, "position": null, "productGroupId": "b10d2eb9-4192-452c-8239-9b373738434d", "productGroupName": "Food", "productId": "4dd288e1-67e8-471d-8bc1-331d986e63c1", "productName": "Baconburger", "productNumber": "1", "productType": 0, "storageInfo": null, "subProductId": null, "subProductQuantity": null, "useBasePrice": true, "variantId": "79ef22be-e697-4597-b2a5-d959e629da2e", "variantName": "180g", "variantNumber": "1", "variantType": 0 }, "quantity": { "value": 2.0 }, "unitQuantity": { "value": 1.0 }, "unit": { "name": "Unit", "type": 1 }, "pricePresetId": null, "productPriceInclTax": { "unitPrice": { "amount": 50.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productPriceExclTax": { "unitPrice": { "amount": 44.64285714285714285714285714, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "productMaterialCostExclTax": { "unitPrice": { "amount": 25.0, "currencyCode": "SEK" }, "additionalPrice": { "amount": 0.0, "currencyCode": "SEK" } }, "kitchenMessage": "Extra sauce", "discountInfo": { "discountId": "1c943352-bc75-4d82-8876-b0fd4bbde98a", "discountName": "20% off burgers!" }, "discount": { "value": 0.20, "type": 0 }, "courseName": "Course name", "coursePosition": 1, "checkPaymentId": null, "paidAt": "2026-10-23T14:33:34.0724868Z", "tag": null, "status": 2, "upsellGroupId": null, "ticketedAt": "2026-10-23T14:33:34.0724871Z", "ticketedTenantUserId": "00ff15b4-636e-4244-b0d7-de09c2b47dfd", "modifications": [ ], "isTaxMandatory": true, "taxes": [ { "id": "dc542ba1-f8c0-47a5-8493-55ef8c138804", "created": "2026-10-23T14:33:34.0724883Z", "modified": "2026-10-23T14:33:34.0724883Z", "tax": { "taxId": "6eccd3dd-3fcb-4e1f-9ffb-3d0a1d3b3fad", "taxValue": { "type": 1, "rate": 12.0 } } } ], "checkItems": [ ], "parentItemId": null, "isMultiproduct": false, "hasOwnPrice": true, "priceInclTax": { "amount": 80.00, "currency": "SEK" }, "priceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalPriceInclTax": { "amount": 80.00, "currency": "SEK" }, "totalPriceExclTax": { "amount": 71.428571428571428571428571429, "currency": "SEK" }, "totalMaterialCostExclTax": { "amount": 50.0, "currency": "SEK" }, "discountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "discountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "totalDiscountAmountInclTax": { "amount": 20.00, "currency": "SEK" }, "totalDiscountAmountExclTax": { "amount": 17.857142857142857142857142857, "currency": "SEK" }, "modificationPriceInclTax": { "amount": 0.0, "currency": "SEK" }, "modificationPriceExclTax": { "amount": 0.0, "currency": "SEK" }, "isPrepaid": false } ], "totalAmount": { "amount": 80.00, "currencyCode": "SEK" }, "totalAmountPlusTip": { "amount": 130.00, "currencyCode": "SEK" }, "taxAmount": { "amount": 8.571428571428571428571428571, "currencyCode": "SEK" }, "subtotalInclTax": { "amount": 80.00, "currencyCode": "SEK" }, "subtotalExclTax": { "amount": 71.42857142857142857142857143, "currencyCode": "SEK" }, "subTotalDiscountInclTax": { "amount": 20.00, "currencyCode": "SEK" }, "subTotalDiscountExclTax": { "amount": 17.85714285714285714285714286, "currencyCode": "SEK" }, "remainingAmountToPay": { "amount": -20.00, "currencyCode": "SEK" }, "awaitingConfirmation": "2026-10-23T14:33:34.0725392Z", "customer": { "email": { "email": "email@email.com" }, "fullName": "Customer name", "customerId": "9fe464ea-9e08-46ed-907d-403784e0588d", "identityUserId": "646b6213-9f9e-4d68-a07b-0cef86a13217", "address": { "street": "Street", "zipCode": "Zip", "city": "City", "state": "", "country": "", "location": { "latitude": 0.0, "longitude": 0.0 } }, "phone": "Phone", "saleSourceId": null }, "guestGroupId": "31a8008d-b14d-4429-8423-a2e2ba294622" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}": { "get": { "tags": [ "Checks" ], "summary": "Get check details V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.Detail.DetailCheckQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } } } }, "delete": { "tags": [ "Checks" ], "summary": "Delete check V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Delete.DeleteCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Delete.DeleteCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks": { "get": { "tags": [ "Checks" ], "summary": "Get outlet check list V2", "description": "### Available filter properties\r\n- referencenumber (long)\r\n- serialnumber (long)\r\n- ticketnumber (long)\r\n", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "MetaFilter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.Outlets.ListCheckOutletQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } } } }, "post": { "tags": [ "Checks" ], "summary": "Create check V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Create.CreateCheckCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Create.CreateCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/SalesLocations/{salesLocationId}": { "get": { "tags": [ "Checks" ], "summary": "Get sales location check list V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "salesLocationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.SalesLocation.ListCheckSalesLocationQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/AddItem": { "post": { "tags": [ "Checks" ], "summary": "Add item V2", "description": "Adds a check item to an existing check or creates a check and adds an item to it.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemCheckResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Items": { "post": { "tags": [ "Checks" ], "summary": "Add items V2", "description": "Adds one or more check items to an existing check in a single operation. If any item cannot be added, none are.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItems.AddItemsCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItems.AddItemsCheckResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Move": { "put": { "tags": [ "Checks" ], "summary": "Move check V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Move.MoveCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Move.MoveCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/CustomName": { "put": { "tags": [ "Checks" ], "summary": "Update check custom name V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomName.UpdateCheckCustomNameCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomName.UpdateCheckCustomNameCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/CustomTicket": { "put": { "tags": [ "Checks" ], "summary": "Update check custom ticket number V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Discount": { "put": { "tags": [ "Checks" ], "summary": "Discount check V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Split": { "put": { "tags": [ "Checks" ], "summary": "Split check V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Split.SplitCheckCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Split.SplitCheckCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Items/Split": { "put": { "tags": [ "Checks" ], "summary": "Split check items V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Split.SplitCheckItemCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Split.SplitCheckItemCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/Items/Discount": { "put": { "tags": [ "Checks" ], "summary": "Discount check items V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Discount.DiscountCheckItemCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Discount.DiscountCheckItemCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/TableReservationMetaData": { "put": { "tags": [ "Checks" ], "summary": "Set check table reservation metadata V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v2/Outlets/{outletId}/Checks/{checkId}/IntegrationPayment": { "put": { "tags": [ "Checks" ], "summary": "Create integration check payment V2", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "checkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.BadRequestResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.LockedResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Companies/{companyId}": { "get": { "tags": [ "Companies" ], "summary": "Get company details", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Queries.Detail.DetailCompanyQueryResponse" }, "example": { "company": { "id": "df314b6c-bd84-4374-a813-f51fcfd03803", "created": "2026-10-23T14:33:34.0983609Z", "modified": "2026-10-23T14:33:34.0983612Z", "tenantId": "71231eaa-029a-4f8f-a7ba-abcdcb764fee", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "562b575f-fb2e-478f-902d-0f51244e4cd8", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": "SE", "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "ac7cd29f-c53d-40c2-b522-e5e9e17c2cbe", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Update company", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.Update.UpdateCompanyCommand" } ] }, "example": { "name": "Updated - Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "gln": null, "companyReference": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.Update.UpdateCompanyCommandResponse" }, "example": { "company": { "id": "fa3fc0d1-0f15-40ba-9b7a-1c3440285b8c", "created": "2026-10-23T14:33:34.0996733Z", "modified": "2026-10-23T14:33:34.0996736Z", "tenantId": "d81a599e-799d-4e7a-aa4c-eb22231f4328", "name": "Updated - Nice food AB", "businessNumber": "551245-1523", "addressId": "cf54a81c-f5d1-49af-9095-7b4cbba7dcef", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": null, "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "812e873f-af1f-4ea6-bf29-531f2f96c6c7", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Delete company", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Companies": { "get": { "tags": [ "Companies" ], "summary": "Get company list", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Queries.List.ListCompanyResponse" }, "example": { "items": [ { "id": "cac43d7a-23e5-4b13-a9b6-802bf2f2f35d", "name": "Nice food AB", "created": "2026-10-23T14:33:34.1021126Z", "lastOrderedAt": "2026-10-23T08:33:34.1021128Z", "invoiceCount": 41, "totalSpent": 12423.23, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null }, { "id": "3d34e43e-ddb3-47f4-a0e1-87df8fbe3e3f", "name": "Okay food AB", "created": "2026-10-23T14:33:34.1021156Z", "lastOrderedAt": "2026-10-23T08:33:34.1021157Z", "invoiceCount": 23, "totalSpent": 5003.0, "originatingOutletId": null, "originatingOutletName": null, "originatingIntegrationType": null } ], "meta": { "count": 2, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "post": { "tags": [ "Companies" ], "summary": "Create company", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.Create.CreateCompanyCommand" } ] }, "example": { "name": "Nice food AB", "businessNumber": "551245-1523", "invoiceAddress": { "addressId": null, "addressType": 0, "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": "46623879876", "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "companyReference": "example company", "gln": "1234567890123" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.Create.CreateCompanyCommandResponse" }, "example": { "company": { "id": "88942b06-d38b-43de-9ece-6c19c2d260a4", "created": "2026-10-23T14:33:34.1036209Z", "modified": "2026-10-23T14:33:34.1036212Z", "tenantId": "4922013e-a962-46f9-9628-7362bd88b657", "name": "Nice food AB", "businessNumber": "551245-1523", "addressId": "d7849089-b19e-4646-baad-b3833f1370e4", "invoiceAddress": { "street": "Kompanigatan 36", "street2": "Höhögatan 69", "zipCode": "666 69", "city": "Höhs" }, "countryCode": null, "phoneNumber": null, "invoiceEmail": "example@company.io", "defaultInvoiceReferenceNote": "Conference room 12", "isDeleted": false, "originatingOutletId": "71365ac5-f01b-4732-b682-438296a483fd", "originatingOutletName": null, "originatingIntegrationType": 3, "gln": "1234567890123", "companyReference": "Example Company" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Companies/{companyId}/Members": { "post": { "tags": [ "Companies" ], "summary": "Create company member", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Create.CreateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Create.CreateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "5a532ca9-1c4c-4bba-a029-7bd185459cc6", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } } }, "deprecated": true }, "get": { "tags": [ "Companies" ], "summary": "Get company members list", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.List.ListCompanyMemberQueryResponse" }, "example": { "items": [ { "id": "ca35ee7b-114e-49e7-ad44-4932a04a1cf8", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } ], "meta": { "count": 1, "offset": 0 } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Outlets/{outletId}/Companies/{companyId}/Members/{memberId}": { "get": { "tags": [ "Companies" ], "summary": "Get company members details", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.Detail.DetailCompanyMemberQueryResponse" }, "example": { "id": "ad8b60d3-d2b1-4bc2-9459-98c5c4e6b3d9", "fullName": "John Doe", "firstName": "John", "lastName": "Doe", "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT", "emailVerified": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Companies" ], "summary": "Update company member", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Update.UpdateCompanyMemberCommand" } ] }, "example": { "firstName": "John", "lastName": "Doe", "phoneNumber": "123456789", "department": "IT" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Update.UpdateCompanyMemberCommandResponse" }, "example": { "companyMember": { "id": "9f4de0a7-5861-4765-9a58-e8c233b51b48", "fullName": "John Doe", "name": { "firstName": "John", "lastName": "Doe" }, "email": "johnjoe@ancon.io", "phoneNumber": "123456789", "department": "IT" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "Companies" ], "summary": "Delete company member", "description": "Will no longer work after 2027-03-31 00:00, move over to user service instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "companyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/v1/Tenants/{tenantId}/Discounts/{discountId}": { "get": { "tags": [ "Discounts" ], "summary": "Get discount details", "description": "Will no longer work after 2025-10-01 00:00, move over to 1.1 version instead.", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "discountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DetailDiscountQueryResponse" }, "example": { "discount": { "id": "c4bb5495-bd63-4ed2-b96b-59d27ef990ba", "name": "Festival Event", "code": "FEST25", "allowMultipleUses": true, "outlets": [ { "id": "d450dc03-6bcd-488a-a600-a765a8f8e135", "name": "Superb Restaurant" } ], "orderFormats": 159, "validPeriod": { "from": "2023-01-01T00:00:00Z", "to": "2023-12-31T23:59:59Z" }, "validDayOfWeek": 127, "validTimePeriod": { "from": "13:00:00", "duration": "08:00:00" }, "allValue": null, "discountType": 0, "discountAvailabilities": 12, "products": null, "productGroups": [ { "id": "f0b3a062-3736-446f-a488-2f7fb1d1482d", "name": "Food", "value": 0.25 }, { "id": "479a5ea4-e120-4843-a9ee-d3608cace2bc", "name": "Drinks", "value": 0.25 } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Tenants/{tenantId}/Discounts": { "get": { "tags": [ "Discounts" ], "summary": "Get discount list", "description": "### Available filter properties\r\n- name (string)\r\n- validperiodfrom (datetime)\r\n- validperiodto (datetime)\r\n- timesused (number)\r\n", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.List.ListDiscountQueryResponse" }, "example": { "items": [ { "id": "99b6104a-4750-48cf-9531-c0d62684a643", "name": "Summer Blast 40%", "code": "SUMMERBLAST40", "timesUsed": 4, "isValid": true, "validPeriod": { "from": "2023-01-01T00:00:00Z", "to": "2023-12-31T23:59:59Z" } }, { "id": "07416830-30e1-4d14-a279-52ff81b59fab", "name": "Winter event 2023", "code": "WINTEREVENT23", "timesUsed": 4, "isValid": true, "validPeriod": { "from": "2023-12-01T00:00:00Z", "to": "2024-01-30T23:59:59Z" } } ], "meta": { "count": 2, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Tenants/{tenantId}/Discounts/{discountId}": { "get": { "tags": [ "Discounts" ], "summary": "Get discount details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "discountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Discounts.Queries.Detail.DetailDiscountQueryResponse" }, "example": { "discount": { "id": "e88400ca-e390-426b-8e05-6ff07a5b5140", "name": "Festival Event", "code": "FEST25", "allowMultipleUses": true, "discountType": 0, "orderFormats": 159, "validPeriod": { "from": "2023-01-01T00:00:00Z", "to": "2023-12-31T23:59:59Z" }, "validDayOfWeek": 127, "validTimePeriod": { "from": "11:00:00", "duration": "08:00:00" }, "allValue": null, "discountAvailabilities": 12, "products": null, "productGroups": [ { "id": "15dc0def-e6b3-4c85-8531-24c83e679d0a", "name": "Food", "value": 0.25 }, { "id": "d71188a1-9fd7-4775-bf75-aafc84d0429e", "name": "Drinks", "value": 0.25 } ], "outlets": [ { "id": "cb1bac5d-732d-4841-b3e3-fb8ec3170d69", "name": "Superb Restaurant" } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Fees/{id}": { "get": { "tags": [ "Fees" ], "summary": "Get fee details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.Queries.Detail.DetailFeeQueryResponse" }, "example": { "fee": { "id": "eb196cdc-60be-4bb8-9c17-5356f265395f", "tenantId": "38843c21-fc67-464f-aa89-595b997bb010", "name": "Delivery fee", "position": 0, "amountInclTax": { "amount": 99.0, "currency": "SEK" }, "isDeleted": false, "taxes": [ { "id": "4576d36f-2f13-4df2-9dc9-6b229895392a", "rate": 12.0 } ], "outletFeeSettings": [ { "outletId": "b860e783-660f-4b72-b586-b8814b4366d8", "outletName": "Example outlet", "accountNumber": "1910", "accountId": "6894c70d-6cab-441d-927a-981afdf1eadb", "voucherTracking": { "costCenter": "12", "project": "F" }, "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Fees": { "get": { "tags": [ "Fees" ], "summary": "Get fee list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- amount (decimal)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.Queries.List.ListFeeQueryResponse" }, "example": { "items": [ { "id": "b0c82ad6-5ad7-45d7-acf6-ff5e41ad48b7", "name": "Delivery fee", "position": 1, "amount": { "amount": 99.0, "currency": "SEK" } } ], "meta": { "count": 1, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Ingredients/{id}": { "get": { "tags": [ "Ingredients" ], "summary": "Get ingridient details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.Detail.DetailIngredientsQueryResponse" }, "example": { "id": "65777ff2-4255-4c25-8680-d6a9465ec5de", "name": "Ingredient", "price": { "amount": 100.0, "currency": "SEK" }, "materialCost": { "amount": 10.0, "currency": "SEK" }, "outletShares": [ { "id": "73ebe79b-9945-41d2-bed9-2571810276f9", "name": "Outlet share", "productShareType": 0 } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Ingredients": { "get": { "tags": [ "Ingredients" ], "summary": "Get ingredients list", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.List.ListIngredientsQueryResponse" }, "example": { "items": [ { "id": "b626e230-3457-443e-a8fc-a980d3ffb3e4", "name": "Ingredient 1", "price": { "amount": 15.0, "currency": "SEK" }, "outletShares": [ { "id": "e7ba80d7-21de-4d48-9727-5ac44f1d61bb", "name": "Outlet 1", "productShareType": 0 }, { "id": "d824563a-1daa-4d71-a2b3-06da0c6c4f00", "name": "Outlet 2", "productShareType": 0 } ] }, { "id": "833f4092-d315-41c1-89e5-d02034b73601", "name": "Ingredient 2", "price": { "amount": 10.0, "currency": "SEK" }, "outletShares": [ { "id": "b62067d7-6269-4081-b987-0367e9614141", "name": "Outlet 3", "productShareType": 1 } ] } ], "meta": { "count": 2, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Integrations/Current": { "get": { "tags": [ "Integrations" ], "summary": "Get details active apitoken", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Integrations.PublicApi.Queries.Detail.Current.DetailCurrentApiTokenQueryResponse" }, "example": { "apiToken": { "id": "0008ca86-ccab-4f63-96d5-89632b660d3e", "created": "2026-10-23T14:33:34.1143122Z", "modified": "2026-10-23T14:33:34.114313Z", "tenantId": "9821ad13-b9e1-4558-9089-142ee7b67907", "outletId": "02359463-a5c5-4020-874f-ab46ba5cca03", "name": "API-Token", "disabled": null } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Invoices": { "get": { "tags": [ "Invoices" ], "summary": "Get invoice list", "description": "### Available filter properties\r\n- created (datetime)\r\n- companyname (string)\r\n- totalamount (decimal)\r\n- totalcurrency (string)\r\n- referencenumber (integer)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "OutletId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Handled", "in": "query", "description": "True or false.\n\nFor true invoices that are handled are returned.\n\nFor false invoices that are unhandled are returned.", "schema": { "type": "boolean" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Invoices.Queries.List.ListInvoiceQueryResponse" }, "example": { "items": [ { "id": "1c8d937f-0437-4e42-a190-c6eaa4166173", "referenceNumber": 341, "createdAt": "2026-10-23T14:33:34.1150507Z", "companyId": "d84ea955-277f-45ff-90ec-0288d306591d", "companyName": "Nice food AB", "total": { "amount": 120.0, "currency": "SEK" }, "handlingStatus": 0, "integrationStatus": null }, { "id": "1d3d3c02-d418-49b8-b7aa-18e2e4a66393", "referenceNumber": 341, "createdAt": "2026-10-23T14:33:34.1150557Z", "companyId": "5ebd6635-a660-457b-8275-fbef33ce7d36", "companyName": "Okay food AB", "total": { "amount": 180.0, "currency": "SEK" }, "handlingStatus": 0, "integrationStatus": "Handled" } ], "meta": { "count": 2, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Invoices/Status": { "put": { "tags": [ "Invoices" ], "summary": "Update invoice status", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Invoices.Commands.UpdateStatus.UpdateStatusCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/MenuTrees": { "get": { "tags": [ "MenuTrees" ], "summary": "Get menu tree list", "description": "### Available filter properties\r\n- created (datetime)\r\n- deleted (datetime)\r\n- name (string)\r\n- ismandatory (boolean)\r\n- type (enum)\r\n- outletshareid (guid)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "OutletId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.List.ListMenuTreesQueryResponse" }, "example": { "items": [ { "id": "313b2f80-e9df-41a8-837a-aae73d7a04e9", "name": "Menu 1", "type": 0, "isMandatory": true, "outletId": null, "outletShares": [ { "id": "52d129c5-dbe7-495d-8d5a-98a2c6defd68", "name": "Outlet 1", "productShareType": 0 }, { "id": "20b9d80d-fa3b-4201-bfb6-ea28a91664be", "name": "Outlet 2", "productShareType": 0 } ] }, { "id": "c238422d-74dd-4afc-9dc0-97c30c19613e", "name": "Menu 2", "type": 1, "isMandatory": false, "outletId": null, "outletShares": [ { "id": "fefeaf9b-010d-48aa-9b1c-2ba73b4a9c5b", "name": "Outlet 1", "productShareType": 0 }, { "id": "cee5ebf6-8fe7-4499-9548-ce34c77eb81d", "name": "Outlet 2", "productShareType": 0 } ] }, { "id": "85b33d34-7b42-427a-8d8d-bd1088ad3c74", "name": "Menu 3", "type": 0, "isMandatory": true, "outletId": "3ebddc1c-cc94-4aed-a2fc-480291e4af2e", "outletShares": [ { "id": "9c992f85-3f6c-4b46-8dab-6ab0526acb1e", "name": "Outlet 1", "productShareType": 0 } ] } ], "meta": { "count": 3, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/MenuTrees/{menuTreeId}": { "get": { "tags": [ "MenuTrees" ], "summary": "Get menu tree details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "menuTreeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.DetailMenuTreeResponse" }, "example": { "id": "36632d35-66e0-4713-8f0a-ae5d07f75ae9", "name": "Example menu tree", "isMandatory": true, "menuTreeItems": [ { "name": "Favorites", "id": "031bb689-c68e-4f09-8ed1-791a9e8422d9", "menuTreeItemType": 2, "menuTreeBranchId": null, "backgroundColor": null, "sortOrder": 0 }, { "name": "Food", "id": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9", "menuTreeItemType": 0, "menuTreeBranchId": null, "backgroundColor": null, "sortOrder": 1 }, { "name": "Drinks", "id": "c1fc870e-d34a-4a3b-b676-16706f8358ac", "menuTreeItemType": 0, "menuTreeBranchId": null, "backgroundColor": null, "sortOrder": 2 }, { "productId": "c553a6ba-060a-4905-8bbc-59d353e4e636", "productName": "Coca cola", "productDescription": null, "id": "b9da79d6-1aa9-4abd-87ad-7c4359320b7e", "menuTreeItemType": 1, "menuTreeBranchId": "031bb689-c68e-4f09-8ed1-791a9e8422d9", "backgroundColor": "#ECB82A", "sortOrder": 0 }, { "productId": "6bc20a5e-25a2-4b71-994c-117be4394daa", "productName": "Hamburger", "productDescription": null, "id": "99a6b020-1ffc-4bff-8a3b-c718b52946ce", "menuTreeItemType": 1, "menuTreeBranchId": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9", "backgroundColor": "#ECB82A", "sortOrder": 0 }, { "productId": "7cfe3f38-0b60-4fec-b69e-8af66a24dc5c", "productName": "Pizza", "productDescription": null, "id": "f5695baf-aff6-40f7-b0c4-f5ada5695f1d", "menuTreeItemType": 1, "menuTreeBranchId": "3c8aaaf1-7531-48cd-b631-341a9b5b16b9", "backgroundColor": "#ECB82A", "sortOrder": 1 }, { "productId": "9901bbc4-510c-4ae2-907a-c046340ffd2a", "productName": "Coca cola", "productDescription": null, "id": "f1d2b4a5-1fc7-48e6-b1ee-ba9aea01dd2b", "menuTreeItemType": 1, "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac", "backgroundColor": "#ECB82A", "sortOrder": 0 }, { "productId": "ebd3800f-a92c-44fb-a8cc-c3e7a4ae0b3a", "productName": "Fanta", "productDescription": null, "id": "d40b9f08-2468-4f8f-8d5a-400cf8867b1b", "menuTreeItemType": 1, "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac", "backgroundColor": "#ECB82A", "sortOrder": 1 }, { "productId": "a747214a-817a-410c-846e-1dd22be66cf8", "productName": "Sprite", "productDescription": null, "id": "94320285-d8a5-4ff8-bbc7-f0db6256ecfe", "menuTreeItemType": 1, "menuTreeBranchId": "c1fc870e-d34a-4a3b-b676-16706f8358ac", "backgroundColor": "#ECB82A", "sortOrder": 2 } ], "outletShares": [ { "id": "442da7eb-aefe-49ae-aa78-507b89929916", "name": "Outlet 1", "productShareType": 0 } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Outlets/{outletId}/MenuTrees/{menuTreeId}/Hierarchy": { "get": { "tags": [ "MenuTrees" ], "summary": "Get menu tree item hierarchy", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "menuTreeId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "SystemVisibility", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Products.SystemVisibilities" } ] } }, { "name": "OrderFormats", "in": "query", "description": "Used to filter the menu on what order format the customer chooses.\nIf no filter is wanted use None, can be useful if all products should be visible but disabled if they are not the correct order format.", "schema": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, { "name": "PurchaseOrderFormat", "in": "query", "description": "Used to give back correct prices in the response, some products have advanced pricing that can be different per order format.", "schema": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, { "name": "OrderTime", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "DayOfWeek", "in": "query", "schema": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ] } }, { "name": "GuestGroupId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.HierarchyMenuTreeResponse" }, "example": { "id": "80f3733f-b43e-4035-8832-b85f84b7c176", "name": "Menu", "isMandatory": true, "menuTreeItems": [ { "name": "Favorites", "items": [ { "productId": "47164474-7337-409a-9296-27426ed62838", "productName": "Lunch", "imageId": null, "productDescription": "Todays lunch", "mainVariantPrice": { "price": { "amount": 89.0, "currency": "SEK" }, "pricePresetId": null, "pricePresetName": null, "showPricePresetLabel": false }, "orderFormat": 3, "productStockCounts": [ ], "productTags": null, "productGroupTags": null, "id": "f3420396-f4d4-493e-af42-107cc79f6ac8", "menuTreeItemType": 1, "menuTreeBranchId": "4875e8dc-0213-4819-a5da-48b596a22a96", "backgroundColor": null, "sortOrder": 1 }, { "productId": "4e42e7a6-f025-4c23-97d8-b5ae89d5b5b0", "productName": "Drink", "imageId": null, "productDescription": "Todays drink", "mainVariantPrice": { "price": { "amount": 25.0, "currency": "SEK" }, "pricePresetId": null, "pricePresetName": null, "showPricePresetLabel": false }, "orderFormat": 3, "productStockCounts": [ { "stockProductId": "efb7ece3-d727-4bcf-a302-aab37c7a11cd", "count": 64.0, "reorderCount": 10.0, "variantId": "2d6478ca-7254-4733-bd6f-9abe65cc2cfe" } ], "productTags": null, "productGroupTags": null, "id": "7ccd03b6-2559-484d-8d1b-20e2aad8e83c", "menuTreeItemType": 1, "menuTreeBranchId": "4875e8dc-0213-4819-a5da-48b596a22a96", "backgroundColor": null, "sortOrder": 2 } ], "contentType": 2, "id": "4875e8dc-0213-4819-a5da-48b596a22a96", "menuTreeItemType": 2, "menuTreeBranchId": null, "backgroundColor": "#0cff00", "sortOrder": 1 }, { "name": "Food", "items": [ { "name": "Hamburgers", "items": [ { "productId": "e42ee551-9aab-44a3-8175-89f5eea7cc72", "productName": "Bacon burger", "imageId": null, "productDescription": null, "mainVariantPrice": { "price": { "amount": 149.0, "currency": "SEK" }, "pricePresetId": "885d70e9-99b6-4227-8585-6c5ff33db89f", "pricePresetName": "Lunch prices", "showPricePresetLabel": true }, "orderFormat": 11, "productStockCounts": [ ], "productTags": null, "productGroupTags": null, "id": "c1cc6d3a-d05b-48df-b828-19f00f88209c", "menuTreeItemType": 1, "menuTreeBranchId": "0ee6ae52-c830-49e4-a947-e68552b38b46", "backgroundColor": null, "sortOrder": 2 } ], "contentType": 2, "id": "0ee6ae52-c830-49e4-a947-e68552b38b46", "menuTreeItemType": 2, "menuTreeBranchId": "030e144f-a36f-4da2-835b-c2af1119917c", "backgroundColor": "#4dbf67", "sortOrder": 1 }, { "name": "Beers", "items": [ { "productId": "6a406b57-a7ee-4923-aae9-163ca091b459", "productName": "Carlsberg 50cl", "imageId": null, "productDescription": null, "mainVariantPrice": { "price": { "amount": 59.0, "currency": "SEK" }, "pricePresetId": "885d70e9-99b6-4227-8585-6c5ff33db89f", "pricePresetName": "Lunch prices", "showPricePresetLabel": true }, "orderFormat": 1, "productStockCounts": [ { "stockProductId": "36c5809f-282b-4823-bc4e-afd64429c7b2", "count": 102.0, "reorderCount": 15.0, "variantId": "e5449b1b-83b3-401a-b3ff-08c1cb446193" } ], "productTags": null, "productGroupTags": null, "id": "811939d1-3459-434e-b00f-8ce45d458588", "menuTreeItemType": 1, "menuTreeBranchId": "7bf7ec5b-70d3-45dd-93c1-5282d9b72364", "backgroundColor": null, "sortOrder": 2 } ], "contentType": 2, "id": "7bf7ec5b-70d3-45dd-93c1-5282d9b72364", "menuTreeItemType": 2, "menuTreeBranchId": "030e144f-a36f-4da2-835b-c2af1119917c", "backgroundColor": "#a81383", "sortOrder": 1 } ], "contentType": 1, "id": "030e144f-a36f-4da2-835b-c2af1119917c", "menuTreeItemType": 2, "menuTreeBranchId": null, "backgroundColor": "#ff0000", "sortOrder": 1 } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/MetadataTemplate": { "post": { "tags": [ "MetadataTemplates" ], "summary": "Create metadata template", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Create.CreateMetadataTemplateCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Create.CreateMetadataTemplateCommandResponse" }, "example": { "metaDataTemplate": { "id": "2ee07cb3-2052-449d-b1b1-2723904990ea", "type": 0, "isDeleted": false, "created": "2026-10-23T14:33:34.1199419Z", "modified": "2026-10-23T14:33:34.1199419Z", "deleted": null, "tenantId": "1800c8d5-6605-4856-b1d8-a3b740a3943b", "data": { "UserSchemaProperties": "abc" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "get": { "tags": [ "MetadataTemplates" ], "summary": "Get metadata template list", "description": "### Available filter properties\r\n- deleted (datetime?)\r\n- type (enum)\r\n", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Queries.List.ListMetadataTemplateQueryResponse" }, "example": { "items": [ { "id": "90b35482-337c-4df4-a4bf-24f7f16ad142", "type": 0, "isDeleted": false, "created": "2026-10-23T14:33:34.1206993Z", "modified": "2026-10-23T14:33:34.1206994Z", "deleted": null, "tenantId": "49dc8fd0-589a-4265-8323-b04fe2d10757", "data": { "UserSchemaProperties": "abc" } } ], "meta": { "count": 1, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/MetadataTemplate/{templateId}": { "get": { "tags": [ "MetadataTemplates" ], "summary": "Get metadata template details", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Queries.Detail.DetailMetadataTemplateQueryResponse" }, "example": { "metaDataTemplate": { "id": "aa5a7192-22ad-4dca-aef3-cd8fbbdf46b1", "type": 0, "isDeleted": false, "created": "2026-10-23T14:33:34.1212729Z", "modified": "2026-10-23T14:33:34.1212729Z", "deleted": null, "tenantId": "e57844e8-22c6-4b8d-9e06-af44c2a085c2", "data": { "UserSchemaProperties": "abc" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "put": { "tags": [ "MetadataTemplates" ], "summary": "Update metadata template", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Update.UpdateMetadataTemplateCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Update.UpdateMetadataTemplateCommandResponse" }, "example": { "metaDataTemplate": { "id": "a49d5dcf-bf43-4ae2-bda1-dad242dc098b", "type": 0, "isDeleted": false, "created": "2026-10-23T14:33:34.1219429Z", "modified": "2026-10-23T14:33:34.1219429Z", "deleted": null, "tenantId": "d877acc3-568e-4fe3-8098-a72c3a5288ce", "data": { "UserSchemaProperties": "abc" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "delete": { "tags": [ "MetadataTemplates" ], "summary": "Delete metadata template", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Orders/DetailedList": { "get": { "tags": [ "Orders" ], "summary": "Get order details list", "description": "### Fetching only new and changed orders\r\nPoll with `filter[modified]=gte:` (UTC, ISO 8601), where the timestamp is the time you started the previous poll minus a minute of overlap. This returns only the orders created or changed since then instead of re-reading the whole day. Because of the overlap an order can be returned more than once, so match orders on `id`.\r\n\r\n`modified` is the time the order itself was last saved. It changes when the order is created, refunded (the refund is a new order with `parentOrderId`, and the original order is updated too), and when its status, pre-order status or invoice handling status changes. A refund payment result that arrives after the refund (for example from a card terminal) may not change `modified`. The nightly accounting run that publishes the day's voucher basis also updates every order of that day, so each order is returned once more after the day is closed. Kitchen ticket progress is not part of the order and does not change `modified`.\r\n\r\n### Available filter properties\r\n- created (datetime)\r\n- modified (datetime)\r\n- order.id (guid)\r\n- orderformat (enum flags)\r\n- customer.id (nullable guid)\r\n- customer.name (string)\r\n- customer.email (string)\r\n- customer.phone (string)\r\n- company.id (guid)\r\n- company.name (string)\r\n- company.email\" (string)\r\n- status (enum)\r\n- refundedat (datetime)\r\n- totalamount (decimal)\r\n- totalcurreny (string)\r\n- totalamountplustip (decimal)\r\n- taxamount (decimal)\r\n- subtotalincltaxamount (decimal)\r\n- subtotalexcltaxamount (decimal)\r\n- subtotaldiscountincltaxamount (decimal)\r\n- subtotaldiscountexcltaxamount (decimal)\r\n- feeamountincltaxamount (decimal)\r\n- feeamountexcltaxamount (decimal)\r\n- discount.id (nullable guid)\r\n- discount.name (string)\r\n- discount.type (enum)\r\n- discount.value (decimal)\r\n- fromtype (enum)\r\n- saleslocation.id (guid)\r\n- saleslocation.type (enum)\r\n- source (string)\r\n- createdchecktenantuserid (nullable guid)\r\n- closedchecktenantuserid (nullable guid)\r\n- createdcheckclientid (nullable guid)\r\n- closedcheckclientid (nullable guid)\r\n- ticktedat (nullable datetime)\r\n- ticketdoneat (nullable datetime)\r\n- capturedat (nullable datetime)\r\n- preparationtime (nullable timespan)\r\n- checkoutservicetime.kind (enum)\r\n- checkoutservicetime.time (datetime)\r\n- customname (string)\r\n- payment.ourreference (guid)\r\n- payment.externalreference (string)\r\n- payment.externalidentifier (string)\r\n- payment.name (string)\r\n- payment.type (enum)\r\n- payment.terminalid (nullable guid)\r\n- payment.clientid (nullable guid)\r\n- payment.tenantuserid (nullable guid)\r\n- payment.invoicereferencenote (string)\r\n- payment.amount (decimal)\r\n- payment.currency (string)\r\n- payment.tipamount (decimal)\r\n- payment.tipcurrency (string)\r\n- payment.cashback (decimal)\r\n- payment.cashbackcurrency (string)\r\n- payment.rounding (decimal)\r\n- payment.roundingcurrency (string)\r\n- payment.status (enum)\r\n- ordernumber (long)\r\n- referencenumber (long)\r\n- ticketnumber (long)\r\n- serialnumber (long)\r\n- refundserialnumber (long)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.Queries.DetaliedList.DetailedListOrderQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/Outlets/{outletId}/Orders/{id}": { "get": { "tags": [ "Orders" ], "summary": "Get order details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.Queries.Details.DetailOrderQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/ClientGroups": { "post": { "tags": [ "OutletClientGroups" ], "summary": "Create outlet client group.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Create.CreateOutletClientGroupCommand" } ] }, "examples": { "Outlet client group example 1": { "value": { "name": "POS group 1", "costCenter": "9668", "project": "2665", "clientIds": [ "2a9c3317-3c30-4ae9-bceb-b30af95fff3d", "8f13da22-1d3b-4a39-a266-e1f3331763c6" ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } }, "Outlet client group example 2": { "value": { "name": "POS group 2", "costCenter": "6658", "project": "7856", "clientIds": [ "c95aaacf-22c3-4095-94b6-121d83b75d4f" ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Create.CreateOutletClientGroupCommandResponse" }, "examples": { "Outlet client group example 1": { "value": { "clientGroup": { "id": "b3c73d96-05be-4770-9798-fe515557e537", "created": "2026-10-23T14:33:34.1481772Z", "modified": "2026-10-23T14:33:34.1481777Z", "outletId": "9488bd53-bc13-4315-97c2-b84f66c00553", "name": "POS Group", "costCenter": "9668", "project": "2665", "clients": [ { "id": "38d6e31f-881f-4088-9ded-096ceebbed80", "name": "POS Licence 1", "clientType": 0 }, { "id": "4bed261e-1069-4f0a-a326-259ee0bba7aa", "name": "POS Licence 2", "clientType": 0 } ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } } } }, "get": { "tags": [ "OutletClientGroups" ], "summary": "Get outlet client list.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.List.ListOutletClientGroupQueryResponse" }, "examples": { "Outlet client groups example 1": { "value": { "items": [ { "id": "60eba1f3-b520-4565-82ae-2cda4748c351", "outletId": "00000000-0000-0000-0000-000000000000", "name": "POS group 1", "costCenter": "9668", "project": "2665" }, { "id": "c5819cb2-c9f0-43f5-b514-a1505ea17b3b", "outletId": "00000000-0000-0000-0000-000000000000", "name": "POS group 2", "costCenter": "6658", "project": "7856" } ], "meta": { "count": 0, "offset": 0 } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/ClientGroups/{id}": { "put": { "tags": [ "OutletClientGroups" ], "summary": "Update outlet client group.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Update.UpdateOutletClientGroupCommand" } ] }, "examples": { "Outlet client group example 1": { "value": { "name": "POS group 1", "costCenter": "9661", "project": "2665", "clientIds": [ "23206068-582e-4b48-9b30-579b4a584c15", "65f488b8-fbc6-48d0-842a-e4a4a758cb14" ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } }, "Outlet client group example 2": { "value": { "name": "POS group 2 - updated", "costCenter": "6658", "project": "7856", "clientIds": [ "7a9a7e01-c29f-47ae-a050-495cb8803c5d" ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Update.UpdateOutletClientGroupCommandResponse" }, "examples": { "Outlet client group example 1": { "value": { "clientGroup": { "id": "6c09cec9-ab3e-45f2-a932-fa802d26adae", "created": "2026-10-23T14:33:34.1521167Z", "modified": "2026-10-23T14:33:34.1521171Z", "outletId": "2d02e1b8-5a68-42dd-9918-9ac732e665d5", "name": "POS Group", "costCenter": "9668", "project": "2665", "clients": [ { "id": "86700a38-a47b-4df7-85ef-eb5fa396bcd5", "name": "POS Licence 1", "clientType": 0 }, { "id": "ea85c4aa-167f-4d4a-9f49-cbf16a307e7d", "name": "POS Licence 2", "clientType": 0 } ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "delete": { "tags": [ "OutletClientGroups" ], "summary": "Delete outlet client group.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "get": { "tags": [ "OutletClientGroups" ], "summary": "Get outlet client group details.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.Detail.DetailOutletClientGroupQueryResponse" }, "examples": { "Outlet client group example 1": { "value": { "clientGroup": { "id": "82b2dd6e-9e7c-4423-835f-9f383d03ea25", "created": "2026-10-23T14:33:34.1543425Z", "modified": "2026-10-23T14:33:34.1543427Z", "outletId": "3fbb6836-6b5f-4aec-9fb2-905cdcbd3e32", "name": "POS Group", "costCenter": "9668", "project": "2665", "clients": [ { "id": "89e3d0f7-029b-4e3f-9969-a3ea8b601c31", "name": "POS Licence 1", "clientType": 0 }, { "id": "37702aad-c235-415c-99bc-290dea4e678e", "name": "POS Licence 2", "clientType": 0 } ], "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Clients": { "get": { "tags": [ "OutletClients" ], "summary": "Get client list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- clienttype (string)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Clients.Queries.List.ListClientsQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}": { "get": { "tags": [ "Outlets" ], "summary": "Get outlet details", "description": "Will no longer work after 2025-10-01 00:00, move over to 1.1 version instead.", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Queries.Detail.DetailOutletQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "put": { "tags": [ "Outlets" ], "summary": "Update outlet", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.UpdateOutletCommand" } ] }, "example": { "tenantId": "00000000-0000-0000-0000-000000000000", "openingHours": [ { "type": 0, "state": 0, "orderFormat": 1, "dayOfWeek": 1, "period": { "from": "2026-10-23T14:33:34.1603373Z", "to": "2026-10-23T22:33:34.1603383Z" }, "timePeriod": { "from": "14:33:34.1603393", "duration": "08:00:00" }, "reason": "Regular hours", "isDefault": true, "position": 1 } ], "blockedVisibilities": 1, "verificationSeries": "f", "voucherTracking": { "costCenter": "Cost Center", "project": "Project" }, "tip": { "showTipAs": 0, "reduceAmountOn": 0 }, "autoOrderVoucherBasisTime": "05:00:00", "generateAutoOrderVoucherBasis": true, "smsSenderId": "SmsSenderId", "autoAcceptOrders": 2, "deliveryArea": { "locations": [ { "latitude": 59.322490, "longitude": 17.885732 }, { "latitude": 59.327063, "longitude": 18.053945 }, { "latitude": 59.349347, "longitude": 18.050435 }, { "latitude": 59.341153, "longitude": 18.102890 } ] }, "supportedOrderFormats": 3, "orderFormatSettings": [ { "orderFormat": 1, "preparationTime": "00:20:00", "options": 2, "minimumOrder": { "amount": 0.1, "currency": "SEK" }, "aoTippingPercentages": { "percentage1Enabled": true, "percentage1Value": 10, "percentage2Enabled": true, "percentage2Value": 15, "percentage3Enabled": true, "percentage3Value": 20 }, "collectionTicketTimerMinutes": null }, { "orderFormat": 2, "preparationTime": "00:20:00", "options": 2, "minimumOrder": { "amount": 0.1, "currency": "SEK" }, "aoTippingPercentages": { "percentage1Enabled": true, "percentage1Value": 10, "percentage2Enabled": true, "percentage2Value": 15, "percentage3Enabled": true, "percentage3Value": 20 }, "collectionTicketTimerMinutes": null } ], "receiptSettings": null } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.UpdateOutletCommandResponse" }, "example": { "outlet": { "id": "31fb2d04-e396-4702-a3da-7a7557d0f79b", "tenantId": "450330aa-a69b-4a69-b339-36e1593631b4", "name": "Outlet name", "businessNumber": "1", "timeZoneOffset": "02:00:00", "openingHours": [ { "type": 0, "state": 0, "orderFormat": 1, "dayOfWeek": 127, "unformattedPeriodFrom": "2026-10-23T14:33:34.1604972Z", "periodFrom": "2026-10-23T00:00:00", "unformattedPeriodTo": "2026-10-24T02:33:34.1604973Z", "periodTo": "2026-10-24T00:00:00", "from": "12:33:34.1604979", "duration": "12:00:00", "reason": "Description", "isDefault": true, "position": 1 } ], "deliveryArea": { "locations": [ { "latitude": 59.3293, "longitude": 18.0686 }, { "latitude": 59.3226, "longitude": 18.0726 }, { "latitude": 59.3261, "longitude": 18.0691 } ] }, "blockedVisibilities": 2, "verificationSeries": "F", "voucherTracking": { "costCenter": "Cost center", "project": "Project" }, "tip": { "showTipAs": 0, "reduceAmountOn": 1 }, "autoOrderVoucherBasisTime": "19:33:34.1605028", "generateAutoOrderVoucherBasis": true, "smsSenderId": "SmsSenderId", "autoAcceptOrderMode": 2, "supportedOrderFormats": 1, "orderFormatSettings": [ { "orderFormat": 159, "preparationTime": "00:30:00", "options": 2, "minimumOrder": { "amount": 100.0, "currency": "SEK" }, "aoTippingPercentages": { "percentage1Enabled": false, "percentage1Value": 0, "percentage2Enabled": false, "percentage2Value": 0, "percentage3Enabled": false, "percentage3Value": 0 } } ], "receiptSettings": { "text": "WiFi password: guest123", "logoId": "befc18e9-d1b9-452b-93d4-2a5ce3735dda" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Outlets/{outletId}": { "get": { "tags": [ "Outlets" ], "summary": "Get outlet details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.DetailOutletQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/ProductGroups/{id}": { "get": { "tags": [ "ProductGroups" ], "summary": "Get product group details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Queries.Detail.DetailProductGroupQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "put": { "tags": [ "ProductGroups" ], "summary": "Update product group", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Update.UpdateProductGroupCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Update.UpdateProductGroupCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true }, "delete": { "tags": [ "ProductGroups" ], "summary": "Delete product group", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/ProductGroups": { "get": { "tags": [ "ProductGroups" ], "summary": "Get product group list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- type (enum)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Queries.List.ListProductGroupQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "post": { "tags": [ "ProductGroups" ], "summary": "Create product group", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Create.CreateProductGroupCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Create.CreateProductGroupCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1.1/Tenants/{tenantId}/ProductGroups": { "post": { "tags": [ "ProductGroups" ], "summary": "Create product group v1.1", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Create.CreateProductGroupCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Create.CreateProductGroupCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Tenants/{tenantId}/ProductGroups/{id}": { "put": { "tags": [ "ProductGroups" ], "summary": "Update product group v1.1", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Update.UpdateProductGroupCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Update.UpdateProductGroupCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{id}": { "get": { "tags": [ "Products" ], "summary": "Get product details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.Detail.DetailProductQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } }, "deprecated": true } }, "/api/v1/Tenants/{tenantId}/Products": { "get": { "tags": [ "Products" ], "summary": "Get product list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- producttype (enum)\r\n- variant.name (string)\r\n- description (string)\r\n- hasvariants (boolean)\r\n- productgroup.id (guid)\r\n- productgroup.name (string)\r\n- menutree.branchid (guid)\r\n- menutree.branchname (string)\r\n- course.id (nullable guid)\r\n- course.name (string)\r\n- course.code (string)\r\n- tag.id (guid)\r\n- tag.name (string)\r\n- tag.type (enum)\r\n- availability.systemvisibility (enum)\r\n- availability.orderformat (enum flags)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "MetaFilter", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.List.ListProductQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "post": { "tags": [ "Products" ], "summary": "Create product draft", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.Create.CreateProductCommand" } ] }, "example": { "productGroupId": "a6860aef-48dd-4792-b424-bf335b7e1905", "productOutletId": "0960d591-f688-4a29-b1b0-abc7b7246d09", "name": "Bacon burger", "description": "A nice bacon burger (200g)", "allergyInformation": "Contains traces of nuts", "hasVariants": false, "mandatoryToPickVariant": false, "autoAccept": true, "availableInAllOutlets": false, "flowViewEnabled": false, "courseId": null } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.Create.CreateProductCommandResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}": { "put": { "tags": [ "Products" ], "summary": "Update product", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.Update.UpdateProductCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } }, "delete": { "tags": [ "Products" ], "summary": "Delete product", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/publish": { "put": { "tags": [ "Products" ], "summary": "Publish product", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/productAvailabilities": { "put": { "tags": [ "Products" ], "summary": "Update product availabilities", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Availabilities.Commands.Update.UpdateProductAvailabilitiesCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LockedResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/shares": { "put": { "tags": [ "Products" ], "summary": "Update product outlet shares", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Shares.Commands.Update.UpdateProductSharesCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/variants": { "post": { "tags": [ "Products" ], "summary": "Create product variant", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.Create.CreateVariantCommand" } ] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.CreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/variants/{variantId}": { "put": { "tags": [ "Products" ], "summary": "Update product variant", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.Update.UpdateVariantCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LockedResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/tags": { "put": { "tags": [ "Products" ], "summary": "Update product tags", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.Tags.ProductTagCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } }, "423": { "description": "Locked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LockedResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/metadata": { "put": { "tags": [ "Products" ], "summary": "Update product meta data", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.Metadata.MetadataProductCommand" } ] }, "example": { "metadataTemplateId": "e2b111b3-7b68-4107-a3f7-f0d369e388a0", "data": { "Value1": "5a5a2564-308a-4102-a756-137ad2802ff8", "Value2": "Test", "Value3": 24, "Value4": 50.343 } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Products/{productId}/SubProducts": { "put": { "tags": [ "Products" ], "summary": "Update sub products", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.Update.UpdateSubProductCommand" } ] }, "example": { "addedSubProducts": [ { "id": null, "productId": "3d920ad6-e3a8-4d41-bbd5-24206bde721b", "productVariantId": "72ac5f19-15f5-48c5-94cc-2f6ced406cba", "price": { "unitPrice": 0.0, "additionalPrice": 0.0 }, "materialCost": { "unitPrice": 0.0, "additionalPrice": 0.0 }, "useOverridePrice": false, "position": 2, "quantity": 3.0 } ], "updatedSubProducts": [ { "id": "d9e1ad35-cb45-4161-8590-18a0ed5cae9f", "productId": "cf86aafb-29e7-4e57-a98e-46f3b0341547", "productVariantId": "8a547aed-2f0f-443a-a0a1-f3cbe9f5bc29", "price": { "unitPrice": 100.0, "additionalPrice": 0.0 }, "materialCost": { "unitPrice": 10.0, "additionalPrice": 0.0 }, "useOverridePrice": true, "position": 1, "quantity": 1.0 } ], "deletedSubProducts": [ "589488a8-a8f4-4f66-b047-5323a43ac892" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.SuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Tenants/{tenantId}/Products/{id}": { "get": { "tags": [ "Products" ], "summary": "Get product details v1.1", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.Detail.DetailProductQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/SaleSources": { "get": { "tags": [ "SaleSources" ], "summary": "Get Sale source list", "description": "### Available filter properties\r\n- created (datetime)\r\n- deleted (datetime)\r\n- type (enum)\r\n- name (string)\r\n- apitokenid (guid)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.SaleSources.Queries.List.ListSaleSourceQueryResponse" }, "example": { "items": [ { "id": "41f6903b-398a-472d-8262-c239b0ac378d", "created": "2026-10-22T14:33:34.1802315Z", "modified": "2026-10-22T14:33:34.1802321Z", "tenantId": null, "name": "OrderApp", "apiTokenId": null, "deleted": null, "type": 0 }, { "id": "90011053-1b28-451d-80fb-2360c2f71cac", "created": "2026-10-22T14:33:34.1802329Z", "modified": "2026-10-22T14:33:34.180233Z", "tenantId": null, "name": "OrderWeb", "apiTokenId": null, "deleted": null, "type": 0 }, { "id": "125fbb38-16d3-4703-bf10-fde88fae4ddd", "created": "2026-10-22T14:33:34.1802333Z", "modified": "2026-10-22T14:33:34.1802333Z", "tenantId": null, "name": "POSClient", "apiTokenId": null, "deleted": null, "type": 0 }, { "id": "e4b427b0-5e72-46d4-83e3-374589b952e2", "created": "2026-10-22T14:33:34.1802335Z", "modified": "2026-10-22T14:33:34.1802335Z", "tenantId": null, "name": "ExpressClient", "apiTokenId": null, "deleted": null, "type": 0 }, { "id": "0e9e3f50-8056-4fc1-989c-6c0f31ae3856", "created": "2026-10-22T14:33:34.1802338Z", "modified": "2026-10-22T14:33:34.1802338Z", "tenantId": null, "name": "Deliverect", "apiTokenId": null, "deleted": null, "type": 0 }, { "id": "145a0c32-6b27-4329-beaa-c9eab7baf250", "created": "2026-10-23T08:33:34.1802391Z", "modified": "2026-10-23T08:33:34.1802394Z", "tenantId": "a9f2c7e4-b7ab-4225-a54c-835ab5fec47e", "name": "Public API - Devs AB", "apiTokenId": "7bdb34e5-0a61-4df8-b1c3-013fe9f396bb", "deleted": null, "type": 1 }, { "id": "4a25db46-4731-44f7-b00e-4ed863467d10", "created": "2026-10-23T08:33:34.1802415Z", "modified": "2026-10-23T08:33:34.1802416Z", "tenantId": "394edc18-f9cb-4ef3-81fe-2e83452c0d5a", "name": "Public API - External company AB", "apiTokenId": "2ed15521-7466-444d-97ec-f2dedeb1ae9e", "deleted": "2026-10-23T11:33:34.1802428Z", "type": 1 } ], "meta": { "count": 7, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Sections": { "get": { "tags": [ "Sections" ], "summary": "Get section list", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "OutletId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.List.ListSectionQueryResponse" }, "example": { "items": [ { "id": "3817176a-3c56-411a-86e5-e96de74c5289", "name": "Section", "tableMapActive": true, "position": 1, "tableCount": 5 }, { "id": "83a6bea8-f196-4983-bac9-d92dab1ae24e", "name": "Section 2", "tableMapActive": true, "position": 2, "tableCount": 10 } ], "meta": { "count": 2, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Sections/{sectionId}/Status": { "get": { "tags": [ "Sections" ], "summary": "Get status section", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.StatusSectionQueryResponse" }, "example": { "id": "ee85301a-13ec-4113-9283-6b4a607f5fc5", "name": "Inside", "tables": [ { "id": "532362ab-426b-4865-bc52-af1c97fd34c3", "number": 1, "checks": [ ], "hasMaitresCustomer": false }, { "id": "c1b25b86-152c-45a6-9991-f9dbe8e55ab8", "number": 2, "checks": [ { "id": "f3cce5fa-70ff-4ebf-a705-45fb05dc4518", "created": "2026-10-23T14:33:34.1815545Z", "ticketNumber": 1001 }, { "id": "e33c7c47-4efb-4ccc-9a24-f35a525ad9d2", "created": "2026-10-23T14:33:34.1815592Z", "ticketNumber": 1002 }, { "id": "d7be93bc-e279-4b44-ad2a-653d502e7f6b", "created": "2026-10-23T14:33:34.1815603Z", "ticketNumber": 1003 } ], "hasMaitresCustomer": false } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Sections/{sectionId}/Tables": { "get": { "tags": [ "Sections" ], "summary": "Get section tables", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.ListResponse`1[[Core.Application.Handlers.Outlets.Sections.Tables.Queries.List.TableModel, Core.Application, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null]]" }, "example": { "items": [ { "id": "adac7055-d04c-4bcd-abde-24915201ed39", "number": 1, "availableForTableOrder": true }, { "id": "b82e400e-9d00-469e-b52a-b5de41b1b536", "number": 2, "availableForTableOrder": false }, { "id": "3d3d68cb-0849-457d-b320-d0dce5a5b5f4", "number": 3, "availableForTableOrder": false }, { "id": "1ed6e0c7-b536-48b9-8392-1f21d5e897f3", "number": 4, "availableForTableOrder": true }, { "id": "ac8a3c35-bb39-4192-83d0-116f6f963d8f", "number": 5, "availableForTableOrder": true } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/SettlementReports": { "get": { "tags": [ "SettlementReports" ], "summary": "Get Adyen settlement report list", "description": "### Available filter properties\r\n- reporttype (enum)\r\n- reportdate (datetime)\r\n- startdate (datetime)\r\n- enddate (datetime)\r\n- batchno (string)\r\n- sum (decimal)\r\n- sumincludingfee (decimal)\r\n- transactionfee (decimal)\r\n- otherfees (decimal)\r\n- total (decimal)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.SettlementReports.Queries.List.ListSettlementReportQueryReponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Tables": { "get": { "tags": [ "Tables" ], "summary": "Get table list", "description": "### Available filter properties\r\n- created (datetime)\r\n- number (integer)\r\n- section.id (nullable guid)\r\n- section.name (string)\r\n- availablefortableorder (boolean)\r\n- externalid (string)", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Tables.Queries.List.ListTablesQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Tables/{tableId}": { "put": { "tags": [ "Tables" ], "summary": "Update external id", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.UpdateTableExternalIdCommand" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.UpdateTableExternalIdCommandResponse" }, "example": { "table": { "id": "b27e8ed3-343c-42ca-878b-ce7bcbbd85eb", "externalId": "ExternalId1" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Tags": { "get": { "tags": [ "Tags" ], "summary": "Get tag list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- type (enum flags)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Tags.Queries.List.ListTagsQueryResponse" }, "example": { "items": [ { "id": "fc99b575-376c-4c9f-8590-c4672caf43db", "name": "Alcohol", "type": 1 }, { "id": "bccff480-fabf-4211-871b-55bb6079068c", "name": "Season", "type": 2 }, { "id": "b823911e-1afd-4172-b88b-71526c5b0801", "name": "Drinks", "type": 2 }, { "id": "e3c5bc72-dea8-4545-a1dc-d7ef8c27ed6a", "name": "Bakery", "type": 3 } ], "meta": { "count": 0, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Taxes/{id}": { "get": { "tags": [ "Taxes" ], "summary": "Get tax details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Taxes.Queries.Detail.DetailTaxQueryResponse" }, "example": { "tax": { "id": "a6edcaea-3a45-43ca-bed8-6e5c09e59b74", "tenantId": "da5a5865-0715-4b54-aea6-38701db40990", "value": { "type": 1, "rate": 12.0 }, "isDeleted": false, "isMandatory": true, "outletTaxSettings": [ { "outletId": "041bc7a0-a650-4b01-a612-64323396e0c0", "outletName": "Example outlet", "accountId": "1c0872b7-2cad-4678-b986-4e1724920235", "accountNumber": "1910", "voucherTracking": { "costCenter": "12", "project": "F" }, "custom1": null, "custom2": null, "custom3": null, "custom4": null, "custom5": null } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/Taxes": { "get": { "tags": [ "Taxes" ], "summary": "Get tax list", "description": "### Available filter properties\r\n- created (datetime)\r\n- rate (string)\r\n- type (enum)\r\n- ismandatory (boolean)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Taxes.Queries.List.ListTaxesQueryResponse" }, "example": { "items": [ { "id": "508ae819-ffda-4c57-ad91-dfbe53fe37f3", "type": 1, "rate": 25.0, "isMandatory": true }, { "id": "293eadf4-f7e5-44bb-a77a-0255e961c5e6", "type": 1, "rate": 12.0, "isMandatory": false }, { "id": "ad46c942-c1de-4e20-afd6-0ff1ddb6b4b9", "type": 1, "rate": 6.0, "isMandatory": false }, { "id": "ae6937bc-cc30-406e-8f94-4c59a2cf6add", "type": 1, "rate": 0.0, "isMandatory": false } ], "meta": { "count": 0, "offset": 0 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants": { "get": { "tags": [ "Tenants" ], "summary": "Get tenant details", "parameters": [ { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Tenants.Queries.Detail.DetailTenantQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/Outlets": { "get": { "tags": [ "Tenants" ], "summary": "Get outlet list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- businessnumber (string)", "parameters": [ { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Tenants.Outlets.Queries.List.ListTenantOutletsQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/TenantUsers/{tenantUserId}": { "get": { "tags": [ "TenantUsers" ], "summary": "Get tenant user details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tenantUserId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.TenantUsers.Queries.Detail.DetailTenantUserQueryResponse" }, "example": { "tenantUser": { "id": "247931e0-bcea-4ff6-bffc-8ccf2aba881b", "created": "2026-10-23T14:33:34.1886457Z", "email": "example@ancon.io", "firstName": "Timon", "lastName": "Quinn", "socialSecurityNumber": "871210-1475", "modified": "2026-10-23T14:33:34.1886464Z", "isDisabled": false, "disabled": null, "isDeleted": false, "deleted": null, "isTenantAdmin": true, "identityUserId": "9da95518-37c9-4901-bd7a-adf6cc95315e", "receiveBroadcastEmails": false } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Tickets/{ticketId}": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket details", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.Detail.DetailTicketQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Outlets/{outletId}/Tickets/DetailedList": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket details list", "description": "### Available filter properties\r\n- created (datetime)\r\n- ticketnumber (long)\r\n- orderformat (enum flags)\r\n- ordertype (enum)\r\n- status (enum)\r\n- salesourceid (guid)\r\n- iscorrectionticket (boolean)\r\n", "parameters": [ { "name": "outletId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.DetailedListTicketQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/UpsellGroups/{upsellGroupsId}": { "get": { "tags": [ "UpsellGroups" ], "summary": "Get upsell group details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "upsellGroupsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.Detail.DetailUpsellGroupQueryResponse" }, "example": { "upsellGroup": { "id": "bebbaacb-13e4-425d-8861-c2e2816a1cfd", "name": "Upsell group name", "products": [ { "id": "9df32bda-bfe2-4f1a-8c7b-cec5c68fae3b", "productId": "bc7d60ef-c5c5-4119-8d0c-5eb7a8b1e414", "variantId": "64f25970-8510-441a-8bbc-02f6f39c2775", "productName": "Upsell product example 1", "variantName": "Upsell product example 1", "hasVariants": false, "position": 0, "hasOwnPrice": false, "defaultPrice": { "unitPrice": { "amount": 100.0, "currency": "SEK" }, "additionalPrice": { "amount": 0.0, "currency": "SEK" } }, "price": { "unitPrice": { "amount": 0.0, "currency": "SEK" }, "additionalPrice": { "amount": 0.0, "currency": "SEK" } }, "outletStocks": [ { "stockProductId": "9c4f4c51-53e1-40f5-bd8e-1d09054a4784", "outletId": "f7434eaa-6b06-4659-afd2-14e237de57ca", "productVariantId": "e2dee7a3-6f4c-4679-a8de-f0a21cfa1e62", "count": 934.0, "reorderCount": 100.0 } ] } ], "outletShares": [ { "id": "522f9a49-c69f-42da-bd09-25b234b13dce", "name": "Outlet share", "productShareType": 0 } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/UpsellGroups": { "get": { "tags": [ "UpsellGroups" ], "summary": "Get upsell group list", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.List.ListUpsellGroupQueryResponse" }, "example": { "items": [ { "id": "054b70e6-b8d4-4eba-9e79-c893c04bf1b6", "name": "Upsell group 1", "outletShares": [ { "id": "44cc47ce-7c69-4628-9cb1-379f530c6ebd", "name": "Outlet 1", "productShareType": 0 }, { "id": "d2df1b49-a8e6-4fc2-a086-fa1e8410d171", "name": "Outlet 2", "productShareType": 0 } ] }, { "id": "ac3708cb-3ab4-4e38-ad02-145425807b01", "name": "Upsell group 2", "outletShares": [ { "id": "f3e3a5bd-a875-47c1-a2e3-ca069b18c7ad", "name": "Outlet 3", "productShareType": 1 } ] } ], "meta": { "count": 2, "offset": 0 } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/WayOfPayments/{id}": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1/Tenants/{tenantId}/WayOfPayments": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- type (enum)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Tenants/{tenantId}/WayOfPayments/{id}": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.1/Tenants/{tenantId}/WayOfPayments": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- type (enum)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.2/Tenants/{tenantId}/WayOfPayments/{id}": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment details", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Extent.Outlets", "in": "query", "schema": { "type": "boolean" } }, { "name": "Extent.Accounts", "in": "query", "schema": { "type": "boolean" } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/api/v1.2/Tenants/{tenantId}/WayOfPayments": { "get": { "tags": [ "WayOfPayments" ], "summary": "Get way of payment list", "description": "### Available filter properties\r\n- created (datetime)\r\n- name (string)\r\n- type (enum)", "parameters": [ { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Offset", "in": "query", "description": "Offset the result, defaults to 0", "schema": { "type": "integer", "format": "int32" } }, { "name": "Limit", "in": "query", "description": "Limits how many items to get, defaults to 100", "schema": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "Order", "in": "query", "description": "Order the result.", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Filter", "in": "query", "description": "Filter the result.\nFilter[created]=gte:2022-01-02 12:00:00&Filter[created]=lte:2022-08-03 22:00:00", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, { "name": "correlationId", "in": "header", "description": "Correlation Id for the request", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.BadRequestResponse" }, "examples": { "Delivery request is not valid": { "value": { "message": "Delivery information is not valid!", "errorCode": "41fcedd1-dfef-4d0d-a5b3-2e28da7dfc9a", "additionalData": null } }, "Delivery to address not supported": { "value": { "message": "Delivery location is outside of outlet's delivery area!", "errorCode": "6bcd96fc-6b76-4456-a759-e2b03ec26e6d", "additionalData": null } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.UnauthorizedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.NotFoundResponse" } } } } } } }, "/websocket/events/checks/CheckCreatedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckCreatedEvent_V20", "description": "Sent when a check is created\n\nClient types: POS\n\nGroups: CheckId, OutletId, SalesLocationId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckCreatedEvent" } } } } } } }, "/websocket/events/checks/CheckUpdatedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckUpdatedEvent_V20", "description": "Sent when a check is updated\n\nClient types: POS, AOW\n\nGroups: CheckId, OutletId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckUpdatedEvent" } } } } } } }, "/websocket/events/checks/CheckDeletedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckDeletedEvent_V20", "description": "Sent when a check is deleted\n\nClient types: POS\n\nGroups: CheckId, OutletId, SalesLocationId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckDeletedEvent" } } } } } } }, "/websocket/events/checks/CheckMovedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckMovedEvent_V20", "description": "Sent when a check is moved between sales locations\n\nClient types: POS\n\nGroups: CheckId, OutletId, GroupId, SalesLocationFrom, SalesLocationTo\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckMovedEvent" } } } } } } }, "/websocket/events/checks/CheckPaidEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckPaidEvent_V20", "description": "Sent when a check is paid\n\nClient types: POS, Express\n\nGroups: CheckId, OutletId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckPaidEvent" } } } } } } }, "/websocket/events/checks/CheckPaymentStatusUpdatedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckPaymentStatusUpdatedEvent_V20", "description": "Sent when a check payment status is updated\n\nClient types: POS, Express\n\nGroups: CheckId, OutletId, CheckPaymentId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckPaymentStatusUpdatedEvent" } } } } } } }, "/websocket/events/checks/CheckUpdatedCustomNameEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckUpdatedCustomNameEvent_V20", "description": "Sent when a check's custom name is updated\n\nClient types: POS\n\nGroups: CheckId, OutletId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckUpdatedCustomNameEvent" } } } } } } }, "/websocket/events/checks/CheckMetadataUpdatedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "CheckMetadataUpdatedEvent_V20", "description": "Sent when a check's metadata is updated\n\nClient types: POS\n\nGroups: CheckId, OutletId, GroupId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckMetadataUpdatedEvent" } } } } } } }, "/websocket/events/checks/ExchangeRatesUpdatedEvent": { "get": { "tags": [ "Checks - Events" ], "summary": "ExchangeRatesUpdatedEvent_V20", "description": "Sent when exchange rates are updated\n\nClient types: POS\n\nGroups: OutletId\n\nScopes: Outlet", "responses": { "200": { "description": "Event payload schema", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.ExchangeRatesUpdatedEvent" } } } } } } } }, "components": { "schemas": { "Core.Api.Controllers.Public.V2.BadRequestResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "message": { "type": "string", "nullable": true, "readOnly": true }, "errorCode": { "type": "string", "format": "uuid", "readOnly": true }, "additionalData": { "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.LockedResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "objectId": { "type": "string", "format": "uuid", "readOnly": true }, "objectType": { "type": "string", "nullable": true, "readOnly": true }, "timeout": { "type": "string", "nullable": true, "readOnly": true }, "reason": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.NotFoundResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemAddOnProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "isMultiproduct": { "type": "boolean", "readOnly": true }, "hasOwnPrice": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "addOnGroupId": { "type": "string", "format": "uuid", "readOnly": true }, "addOnGroupName": { "type": "string", "nullable": true, "readOnly": true }, "freeAmount": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "isMultiproduct": { "type": "boolean", "readOnly": true }, "hasOwnPrice": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "checkPaymentId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paidAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckItemStatuses" } ], "readOnly": true }, "ticketedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ticketedTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isPrepaid": { "type": "boolean", "readOnly": true }, "usedAccountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ModificationModel" }, "nullable": true, "readOnly": true }, "subCheckItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.SubCheckItemModel" }, "nullable": true, "readOnly": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemAddOnProductModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Discount.DiscountCheckItemCommand": { "required": [ "checkItemIds" ], "type": "object", "properties": { "checkItemIds": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" } }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountValueModel" } ], "nullable": true }, "discountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Discount.DiscountCheckItemCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Split.SplitCheckItemCommand": { "required": [ "checkItemIds", "parts" ], "type": "object", "properties": { "parts": { "maximum": 100, "minimum": 2, "type": "integer", "format": "int32" }, "checkItemIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItems.Commands.Split.SplitCheckItemCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "created": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" }, "nullable": true, "readOnly": true }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMetadataModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "reference": { "type": "string", "nullable": true, "readOnly": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "isSystem": { "type": "boolean", "readOnly": true }, "metadata": { "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMiniModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "deleted": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "closedCheckTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckTenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "closedCheckClientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckClientId": { "type": "string", "format": "uuid", "readOnly": true }, "deletedReason": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "companyInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.CompanyInfoModel" } ], "nullable": true, "readOnly": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.CustomerInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "guestCount": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "saleSourceId": { "type": "string", "format": "uuid", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "readOnly": true }, "serialNumber": { "type": "integer", "format": "int64", "readOnly": true }, "referenceNumber": { "type": "integer", "format": "int64", "readOnly": true }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isHidden": { "type": "boolean", "readOnly": true }, "awaitingConfirmation": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckStatuses" } ], "readOnly": true }, "totalAmount": { "type": "number", "format": "double", "readOnly": true }, "totalAmountPlusTip": { "type": "number", "format": "double", "readOnly": true }, "taxAmount": { "type": "number", "format": "double", "readOnly": true }, "subtotalInclTax": { "type": "number", "format": "double", "readOnly": true }, "subtotalExclTax": { "type": "number", "format": "double", "readOnly": true }, "subTotalDiscountInclTax": { "type": "number", "format": "double", "readOnly": true }, "subTotalDiscountExclTax": { "type": "number", "format": "double", "readOnly": true }, "remainingAmountToPay": { "type": "number", "format": "double", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" }, "nullable": true, "readOnly": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckPaymentModel" }, "nullable": true, "readOnly": true }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMetadataModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "paymentType": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PaymentTypes" } ], "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "cashBackAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "roundingAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "externalReference": { "type": "string", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckPaymentStatuses" } ], "readOnly": true }, "terminalId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paymentMethod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PaymentMethodModel" } ], "nullable": true, "readOnly": true }, "externalIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "clientId": { "type": "string", "format": "uuid", "readOnly": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "paymentDoneAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "errorType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CardPaymentErrorTypes" } ], "nullable": true, "readOnly": true }, "tenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "tipAmount": { "type": "number", "format": "double", "readOnly": true }, "centralControlUnitSerial": { "type": "string", "nullable": true, "readOnly": true }, "isReceiptPrinted": { "type": "boolean", "readOnly": true }, "invoiceReferenceNote": { "type": "string", "nullable": true, "readOnly": true }, "receipts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ReceiptModel" }, "nullable": true, "readOnly": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckPaymentTransactionModel" }, "nullable": true, "readOnly": true }, "usedGiftCard": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.GiftCardValuesModel" } ], "nullable": true, "readOnly": true }, "usedWallet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.WalletInfoModel" } ], "nullable": true, "readOnly": true }, "topUpWallets": { "type": "array", "items": { "$ref": "#/components/schemas/System.Tuple`2[[Core.Api.Controllers.Public.V2.Sales.Checks.V0.WalletInfoModel, Core.Api, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null],[Shared.ValueObjects.Money, Shared, Version=1.0.1781.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true, "readOnly": true }, "omniboostRoomsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.IdNameModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckPaymentTransactionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionTypes" } ], "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionStatuses" } ], "readOnly": true }, "externalReference": { "type": "string", "nullable": true, "readOnly": true }, "externalData": { "type": "string", "nullable": true, "readOnly": true }, "errorDetails": { "type": "string", "nullable": true, "readOnly": true }, "confirmationData": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckSalesLocationModel": { "type": "object", "properties": { "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "readOnly": true }, "serialNumber": { "type": "integer", "format": "int64", "readOnly": true }, "referenceNumber": { "type": "integer", "format": "int64", "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "remainingAmountToPay": { "type": "number", "format": "double", "readOnly": true }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMetadataModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemCheckCommand": { "required": [ "item" ], "type": "object", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemItemModel" } ] }, "courseId": { "type": "string", "format": "uuid", "nullable": true }, "checkId": { "type": "string", "format": "uuid", "nullable": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.CreateDataModel" } ], "nullable": true }, "isPrepaid": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemCheckResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "checkItem": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" } ], "nullable": true, "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMiniModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemItemModel": { "required": [ "quantity", "variantId" ], "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "quantity": { "maximum": 100000, "minimum": -100000, "type": "number", "format": "double" }, "kitchenMessage": { "maxLength": 100, "type": "string", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.CheckItemPriceModel" } ], "nullable": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true }, "tag": { "maxLength": 256, "type": "string", "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.ProductItemModificationModel" }, "nullable": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddOnProductModel" }, "nullable": true }, "subProductSpecification": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.SubProductSpecificationModel" }, "description": "Gets or sets the list of sub product specifications. It is used when adding a multi product with sub product with optional variant.\nIn those cases a variant has to be selected.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddOnProductModel": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "addOnGroupId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "freeAmount": { "type": "number", "format": "double" }, "unitQuantity": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.CheckItemPriceModel": { "type": "object", "properties": { "unitPrice": { "type": "number", "format": "double" }, "additionalPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.CreateDataModel": { "required": [ "orderFormat", "salesLocationId", "salesLocationType" ], "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] }, "salesLocationId": { "type": "string", "format": "uuid" }, "guestCount": { "type": "integer", "format": "int32", "nullable": true }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true }, "externalTableId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.ProductItemModificationModel": { "type": "object", "properties": { "modification": { "type": "string", "nullable": true }, "ingredientId": { "type": "string", "format": "uuid", "nullable": true }, "addOnGroupId": { "type": "string", "format": "uuid", "nullable": true }, "replaceId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "freeAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.SubProductSpecificationModel": { "type": "object", "properties": { "subProductId": { "type": "string", "format": "uuid" }, "subProductVariantId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItems.AddItemsCheckCommand": { "required": [ "items" ], "type": "object", "properties": { "items": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItem.AddItemItemModel" }, "description": "Gets or sets the items to add. They are all added to the check in one operation;\nif any item fails nothing is added." }, "courseId": { "type": "string", "description": "Gets or sets the course to assign to every item in the request.", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.AddItems.AddItemsCheckResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "created": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" }, "description": "Gets the items that were added as new check item lines.", "nullable": true, "readOnly": true }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemModel" }, "description": "Gets the items that merged into an already existing check item line.", "nullable": true, "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Create.CreateCheckCommand": { "required": [ "orderFormat", "salesLocationId", "salesLocationType" ], "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] }, "salesLocationId": { "type": "string", "format": "uuid" }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true }, "guestCount": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "customName": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Create.CreateCheckCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomName.UpdateCheckCustomNameCommand": { "type": "object", "properties": { "customName": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomName.UpdateCheckCustomNameCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommand": { "type": "object", "properties": { "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Delete.DeleteCheckCommand": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Delete.DeleteCheckCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountCheckCommand": { "type": "object", "properties": { "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountValueModel" } ], "nullable": true }, "code": { "maxLength": 10, "pattern": "^[a-zåäöA-ZÅÄÖ0-9!_.-]*$", "type": "string", "nullable": true }, "discountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountCheckCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Discount.DiscountValueModel": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Move.MoveCheckCommand": { "required": [ "salesLocationType" ], "type": "object", "properties": { "salesLocationId": { "type": "string", "format": "uuid" }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Move.MoveCheckCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Split.SplitCheckCommand": { "required": [ "parts" ], "type": "object", "properties": { "parts": { "maximum": 100, "minimum": 2, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Commands.Split.SplitCheckCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "originalCheck": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.GiftCardValuesModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "giftCardNumber": { "type": "string", "nullable": true, "readOnly": true }, "giftCardNumberType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CardNumberTypes" } ], "readOnly": true }, "soldDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "balance": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommand": { "required": [ "tableReservationMetadata" ], "type": "object", "properties": { "tableReservationMetadata": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.TableReservationMetadataModel" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Metadata.Commands.SetTableReservation.TableReservationMetadataModel": { "type": "object", "properties": { "reservationArrivalDateTime": { "type": "string", "format": "date-time", "nullable": true }, "reservationEndDateTime": { "type": "string", "format": "date-time", "nullable": true }, "customerFirstName": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Name" } ], "nullable": true }, "customerLastName": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Name" } ], "nullable": true }, "customerEmail": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.EmailAddress" } ], "nullable": true }, "customerPhone": { "type": "string", "nullable": true }, "guestCount": { "type": "integer", "format": "int32", "nullable": true }, "reservationId": { "type": "string", "nullable": true }, "customNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommand": { "type": "object", "properties": { "paymentAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true }, "tipAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true }, "externalReference": { "type": "string", "nullable": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommandResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.Detail.DetailCheckQueryResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.Outlets.ListCheckOutletQueryResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckMiniModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.Queries.SalesLocation.ListCheckSalesLocationQueryResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckSalesLocationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.SubCheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "isMultiproduct": { "type": "boolean", "readOnly": true }, "hasOwnPrice": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "parentUseBasePrice": { "type": "boolean", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SubCheckItemStatuses" } ], "readOnly": true }, "usedAccountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ModificationModel" }, "nullable": true, "readOnly": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.CheckItemAddOnProductModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.Sales.Checks.V0.WalletInfoModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "walletNumber": { "type": "string", "nullable": true, "readOnly": true }, "walletNumberType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.WalletNumberTypes" } ], "readOnly": true }, "soldDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "balance": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.Public.V2.UnauthorizedResponse": { "type": "object", "properties": { "timestamp": { "type": "integer", "description": "Gets the timestamp in Unix time milliseconds when this response is created.", "format": "int64", "readOnly": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.AddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true, "readOnly": true }, "zipCode": { "type": "string", "nullable": true, "readOnly": true }, "city": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.LocationModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.IdNameModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.LocationModel": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "readOnly": true }, "longitude": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.MoneyModel": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.PaymentMethodModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ], "readOnly": true }, "displayName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.PricePerUnitModel": { "type": "object", "properties": { "unitPrice": { "type": "number", "format": "double" }, "additionalPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckItemAddOnProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "addOnGroupId": { "type": "string", "format": "uuid", "readOnly": true }, "addOnGroupName": { "type": "string", "nullable": true, "readOnly": true }, "freeAmount": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "checkPaymentId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paidAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckItemStatuses" } ], "readOnly": true }, "ticketedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ticketedTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isPrepaid": { "type": "boolean", "readOnly": true }, "usedAccountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ModificationModel" }, "nullable": true, "readOnly": true }, "subCheckItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.SubCheckItemModel" }, "nullable": true, "readOnly": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckItemAddOnProductModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckMetadataModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "reference": { "type": "string", "nullable": true, "readOnly": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "isSystem": { "type": "boolean", "readOnly": true }, "metadata": { "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "deleted": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "closedCheckTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckTenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "closedCheckClientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckClientId": { "type": "string", "format": "uuid", "readOnly": true }, "deletedReason": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "companyInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.CompanyInfoModel" } ], "nullable": true, "readOnly": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.CustomerInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "guestCount": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "saleSourceId": { "type": "string", "format": "uuid", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "readOnly": true }, "serialNumber": { "type": "integer", "format": "int64", "readOnly": true }, "referenceNumber": { "type": "integer", "format": "int64", "readOnly": true }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isHidden": { "type": "boolean", "readOnly": true }, "awaitingConfirmation": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckStatuses" } ], "readOnly": true }, "totalAmount": { "type": "number", "format": "double", "readOnly": true }, "taxAmount": { "type": "number", "format": "double", "readOnly": true }, "subtotalInclTax": { "type": "number", "format": "double", "readOnly": true }, "subtotalExclTax": { "type": "number", "format": "double", "readOnly": true }, "subTotalDiscountInclTax": { "type": "number", "format": "double", "readOnly": true }, "subTotalDiscountExclTax": { "type": "number", "format": "double", "readOnly": true }, "remainingAmountToPay": { "type": "number", "format": "double", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckItemModel" }, "nullable": true, "readOnly": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckPaymentModel" }, "nullable": true, "readOnly": true }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckMetadataModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "paymentType": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PaymentTypes" } ], "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "cashBackAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "roundingAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "externalReference": { "type": "string", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckPaymentStatuses" } ], "readOnly": true }, "terminalId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paymentMethod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PaymentMethodModel" } ], "nullable": true, "readOnly": true }, "externalIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "clientId": { "type": "string", "format": "uuid", "readOnly": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "paymentDoneAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "errorType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CardPaymentErrorTypes" } ], "nullable": true, "readOnly": true }, "tenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "tipAmount": { "type": "number", "format": "double", "readOnly": true }, "centralControlUnitSerial": { "type": "string", "nullable": true, "readOnly": true }, "isReceiptPrinted": { "type": "boolean", "readOnly": true }, "invoiceReferenceNote": { "type": "string", "nullable": true, "readOnly": true }, "receipts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ReceiptModel" }, "nullable": true, "readOnly": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckPaymentTransactionModel" }, "nullable": true, "readOnly": true }, "usedGiftCard": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.GiftCardValuesModel" } ], "nullable": true, "readOnly": true }, "usedWallet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.WalletInfoModel" } ], "nullable": true, "readOnly": true }, "topUpWallets": { "type": "array", "items": { "$ref": "#/components/schemas/System.Tuple`2[[Core.Api.Controllers.V2.Sales.Checks.V0.WalletInfoModel, Core.Api, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null],[Shared.ValueObjects.Money, Shared, Version=1.0.1781.0, Culture=neutral, PublicKeyToken=null]]" }, "nullable": true, "readOnly": true }, "omniboostRoomsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.IdNameModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.CheckPaymentTransactionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionTypes" } ], "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionStatuses" } ], "readOnly": true }, "externalReference": { "type": "string", "nullable": true, "readOnly": true }, "externalData": { "type": "string", "nullable": true, "readOnly": true }, "errorDetails": { "type": "string", "nullable": true, "readOnly": true }, "confirmationData": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.GiftCardValuesModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "giftCardNumber": { "type": "string", "nullable": true, "readOnly": true }, "giftCardNumberType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CardNumberTypes" } ], "readOnly": true }, "soldDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true }, "balance": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.SubCheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "productMaterialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountInfoModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.TaxValueModel" }, "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.PricePerUnitModel" } ], "readOnly": true }, "priceInclTax": { "type": "number", "format": "double", "readOnly": true }, "priceExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "productPricePerQuantityInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalMaterialCostExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountableAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "discountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountAmountExclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "modificationPriceExclTax": { "type": "number", "format": "double", "readOnly": true }, "discountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "totalDiscountablePriceInclTax": { "type": "number", "format": "double", "readOnly": true }, "parentUseBasePrice": { "type": "boolean", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SubCheckItemStatuses" } ], "readOnly": true }, "usedAccountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ModificationModel" }, "nullable": true, "readOnly": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckItemAddOnProductModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.Checks.V0.WalletInfoModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "walletNumber": { "type": "string", "nullable": true, "readOnly": true }, "walletNumberType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.WalletNumberTypes" } ], "readOnly": true }, "soldDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "balance": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.CompanyInfoModel": { "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "companyName": { "type": "string", "nullable": true, "readOnly": true }, "companyBusinessNumber": { "type": "string", "nullable": true, "readOnly": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.GeneralAddressModel" } ], "nullable": true, "readOnly": true }, "invoiceEmail": { "type": "string", "nullable": true, "readOnly": true }, "memberId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "memberName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.CustomerInfoModel": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "identityUserId": { "type": "string", "format": "uuid", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.AddressModel" } ], "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.DiscountInfoModel": { "type": "object", "properties": { "discountId": { "type": "string", "format": "uuid", "nullable": true }, "discountName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.DiscountValueModel": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.GeneralAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.ModificationModel": { "type": "object", "properties": { "modification": { "type": "string", "nullable": true, "readOnly": true }, "cost": { "type": "number", "format": "double", "readOnly": true }, "materialCost": { "type": "number", "format": "double", "readOnly": true }, "ingredientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "addOnGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "replaceId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "replacementName": { "type": "string", "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "freeAmount": { "type": "number", "format": "double", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.OrderedProductModel": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid", "readOnly": true }, "productName": { "type": "string", "nullable": true, "readOnly": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ], "readOnly": true }, "variantId": { "type": "string", "format": "uuid", "readOnly": true }, "variantName": { "type": "string", "nullable": true, "readOnly": true }, "variantType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.VariantTypes" } ], "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "productGroupId": { "type": "string", "format": "uuid", "readOnly": true }, "productGroupName": { "type": "string", "nullable": true, "readOnly": true }, "glassesPerBottle": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "useBasePrice": { "type": "boolean", "readOnly": true }, "isSystemProduct": { "type": "boolean", "readOnly": true }, "productNumber": { "type": "string", "nullable": true, "readOnly": true }, "variantNumber": { "type": "string", "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "storageInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.StorageInformation" } ], "nullable": true, "readOnly": true }, "subProductQuantity": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "subProductId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.ReceiptModel": { "type": "object", "properties": { "receiverType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ReceiptReceiverTypes" } ] }, "needsSignature": { "type": "boolean" }, "receiptTexts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.ReceiptTextModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.ReceiptTextModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.SalesLocationInfoModel": { "type": "object", "properties": { "salesLocationId": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.V2.Sales.StorageInformation": { "type": "object", "properties": { "temperature": { "type": "integer", "format": "int32" }, "size": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.SizeModel" } ] } }, "additionalProperties": false }, "Core.Api.Controllers.V2.SizeModel": { "type": "object", "properties": { "height": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Controllers.V2.TaxValueModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Controllers.V2.UnitModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.UnitTypes" } ] } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.CheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "quantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unitQuantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Unit" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountValue" } ], "nullable": true, "readOnly": true }, "checkPaymentId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paidAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckItemStatuses" } ], "readOnly": true }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "ticketedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ticketedTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyOrderedProduct" } ], "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the\nproduction package (1.0.1200-alpha). The current package marks IsSystemProduct with\n[JsonIgnore], which would silently drop the field from the legacy payloads, so the raw\nvalue object cannot be serialized directly anymore. Frozen - do not change.", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountInfo" } ], "nullable": true, "readOnly": true }, "parentItemId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.Dtos.CheckTaxDto" }, "nullable": true, "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.CheckItemProductModificationModel" }, "nullable": true, "readOnly": true }, "checkItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.CheckItemModel" }, "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isPrepaid": { "type": "boolean", "readOnly": true }, "usedAccountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.CheckItemSubAddOnProductDto" }, "nullable": true, "readOnly": true }, "attendeeId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "autoAccept": { "type": "boolean", "readOnly": true }, "hasCourseSupport": { "type": "boolean", "readOnly": true } }, "additionalProperties": false, "description": "Restored 1.0 wire shape of the old domain CheckItemDto as serialized inside the legacy\nCheckPaidEvent websocket payload on alpha/production (before the check item domain was\nrestructured into CheckItemDto/SubCheckItemDto). Frozen - do not change the serialized surface." }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.CheckItemProductModificationModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "itemId": { "type": "string", "format": "uuid", "readOnly": true }, "modification": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyProductModification" } ], "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the\nproduction package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The\ncurrent package flattened them to decimals, so the raw value object cannot be serialized\ndirectly anymore. Frozen - do not change.", "nullable": true } }, "additionalProperties": false, "description": "Restored 1.0 wire shape of the check item modification inside the legacy CheckPaidEvent\nwebsocket payload (the nested ProductModification must serialize its production shape with\nmoney-based costs). Frozen - do not change the serialized surface." }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.CheckItemSubAddOnProductDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "quantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unitQuantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Unit" } ], "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountValue" } ], "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckItemStatuses" } ] }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyOrderedProduct" } ], "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the\nproduction package (1.0.1200-alpha). The current package marks IsSystemProduct with\n[JsonIgnore], which would silently drop the field from the legacy payloads, so the raw\nvalue object cannot be serialized directly anymore. Frozen - do not change.", "nullable": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountInfo" } ], "nullable": true, "readOnly": true }, "addOnGroupId": { "type": "string", "format": "uuid", "readOnly": true }, "addOnGroupName": { "type": "string", "nullable": true, "readOnly": true }, "freeAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "position": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.SortPosition" } ], "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Checks.Dtos.CheckTaxDto" }, "nullable": true, "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "addOnGroupLocalizedCustomerFacingNames": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.LocalizedString" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Restored 1.0 wire shape of the old Dtos.CheckItemSubAddOnProductDto (deleted when the\ncheck item domain was restructured). Serialized inside the legacy CheckCreatedEvent and\nCheckPaidEvent websocket payloads. Frozen - do not change the serialized surface.\nMapped from the current Ancon.Wildcat.Core.Domain.Models.Sales.Checks.Dtos.CheckItemAddOnProductDto." }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyOrderedProduct": { "type": "object", "properties": { "glassesPerBottle": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "isSystemProduct": { "type": "boolean", "readOnly": true }, "localizedProductNames": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.LocalizedString" } ], "nullable": true, "readOnly": true }, "localizedVariantNames": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.LocalizedString" } ], "nullable": true, "readOnly": true }, "position": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.SortPosition" } ], "nullable": true, "readOnly": true }, "productGroupId": { "type": "string", "format": "uuid", "readOnly": true }, "productGroupName": { "type": "string", "nullable": true, "readOnly": true }, "productId": { "type": "string", "format": "uuid", "readOnly": true }, "productName": { "type": "string", "nullable": true, "readOnly": true }, "productNumber": { "type": "string", "nullable": true, "readOnly": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ], "readOnly": true }, "storageInfo": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.StorageInformation" } ], "nullable": true, "readOnly": true }, "subProductId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "subProductQuantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "useBasePrice": { "type": "boolean", "readOnly": true }, "variantId": { "type": "string", "format": "uuid", "readOnly": true }, "variantName": { "type": "string", "nullable": true, "readOnly": true }, "variantNumber": { "type": "string", "nullable": true, "readOnly": true }, "variantType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.VariantTypes" } ], "readOnly": true } }, "additionalProperties": false, "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the\nproduction package (1.0.1200-alpha). The current package marks IsSystemProduct with\n[JsonIgnore], which would silently drop the field from the legacy payloads, so the raw\nvalue object cannot be serialized directly anymore. Frozen - do not change." }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyProductModification": { "type": "object", "properties": { "addOnGroup": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Sales.ProductAddOnGroup" } ], "nullable": true, "readOnly": true }, "cost": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "freeAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "ingredient": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Sales.ProductIngredient" } ], "nullable": true, "readOnly": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "modification": { "type": "string", "nullable": true }, "position": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.SortPosition" } ], "nullable": true, "readOnly": true }, "quantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "replacement": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Sales.ProductIngredient" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the\nproduction package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The\ncurrent package flattened them to decimals, so the raw value object cannot be serialized\ndirectly anymore. Frozen - do not change." }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckCreatedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckDeletedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckMetadataUpdatedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true }, "checkMetadata": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckMetadataModel" } ], "nullable": true, "readOnly": true }, "previousCheckMetadata": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckMetadataModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckMovedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true }, "salesLocationFrom": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true }, "salesLocationTo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckPaidEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true }, "paymentId": { "type": "string", "format": "uuid", "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.SalesLocationInfoModel" } ], "readOnly": true }, "isTablePayment": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckPaymentStatusUpdatedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "checkId": { "type": "string", "format": "uuid", "readOnly": true }, "checkPayment": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckPaymentModel" } ], "nullable": true, "readOnly": true }, "additionalData": { "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckUpdatedCustomNameEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.CheckUpdatedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.CheckModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V2.V0.ExchangeRatesUpdatedEvent": { "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "timestamp": { "type": "integer", "format": "int64" }, "outletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.AddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LocationModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.ApiTokenModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "disabled": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.BadRequestResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid" }, "additionalData": { "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.CreatedResponse": { "type": "object", "additionalProperties": false }, "Core.Api.Models.Public.V1.DateRangeModel": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time", "readOnly": true }, "endDate": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.DeliveryModel": { "type": "object", "properties": { "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.AddressModel" } ], "nullable": true }, "phone": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.GeneralAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true, "readOnly": true }, "street2": { "type": "string", "nullable": true, "readOnly": true }, "zipCode": { "type": "string", "nullable": true, "readOnly": true }, "city": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.IdNameModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.InvoiceAddressModel": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.ListResponse`1[[Core.Application.Handlers.Outlets.Sections.Tables.Queries.List.TableModel, Core.Application, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Application.Handlers.Outlets.Sections.Tables.Queries.List.TableModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.LocationModel": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.LockedResponse": { "type": "object", "properties": { "objectId": { "type": "string", "format": "uuid" }, "objectType": { "type": "string", "nullable": true }, "timeout": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.MoneyModel": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.NotFoundResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.OutletShareQueryModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "productShareType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductShareTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.PagedResponseMetadata": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.PaymentMethodModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.PeriodModel": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.PricePerUnitMoneyModel": { "type": "object", "properties": { "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "additionalPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.SuccessResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.TaxValueModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.TimePeriodModel": { "type": "object", "properties": { "from": { "type": "string", "format": "time" }, "duration": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.UnauthorizedResponse": { "type": "object", "properties": { "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Commands.CompanyAddressModel": { "type": "object", "properties": { "addressId": { "type": "string", "format": "uuid", "nullable": true }, "addressType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.AddressTypes" } ] }, "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Commands.Create.CreateCompanyCommand": { "required": [ "invoiceAddress", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of the company" }, "businessNumber": { "type": "string", "description": "Business number of the company", "nullable": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.CompanyAddressModel" } ] }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "description": "Phonenumber of the company", "nullable": true }, "invoiceEmail": { "type": "string", "description": "Email of the company or person in the company", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "description": "Will be the default reference note for all new invoices from this company.", "nullable": true }, "companyReference": { "type": "string", "description": "Company reference note for the company. This maps to YourReference property on Fortnox.", "nullable": true }, "gln": { "type": "string", "description": "GLN of the company.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Commands.Create.CreateCompanyCommandResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Commands.Update.UpdateCompanyCommand": { "required": [ "invoiceAddress", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "businessNumber": { "type": "string", "nullable": true }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Commands.CompanyAddressModel" } ] }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true }, "gln": { "type": "string", "nullable": true }, "companyReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Commands.Update.UpdateCompanyCommandResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Create.CreateCompanyMemberCommand": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Create.CreateCompanyMemberCommandResponse": { "type": "object", "properties": { "companyMember": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.CompanyMemberModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Update.UpdateCompanyMemberCommand": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Commands.Update.UpdateCompanyMemberCommandResponse": { "type": "object", "properties": { "companyMember": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.CompanyMemberModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.CompanyMemberModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "name": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PersonalName" } ], "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.Detail.DetailCompanyMemberQueryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.List.CompanyMemberModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fullName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.List.ListCompanyMemberQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyMembers.Queries.List.CompanyMemberModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.CompanyModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "businessNumber": { "type": "string", "nullable": true }, "addressId": { "type": "string", "format": "uuid" }, "invoiceAddress": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.InvoiceAddressModel" } ], "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "defaultInvoiceReferenceNote": { "type": "string", "nullable": true }, "isDeleted": { "type": "boolean" }, "originatingOutletId": { "type": "string", "format": "uuid", "nullable": true }, "originatingOutletName": { "type": "string", "nullable": true }, "originatingIntegrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true }, "gln": { "type": "string", "nullable": true }, "companyReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Queries.Detail.DetailCompanyQueryResponse": { "type": "object", "properties": { "company": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.CompanyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Queries.List.CompanyModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "lastOrderedAt": { "type": "string", "format": "date-time", "nullable": true }, "invoiceCount": { "type": "integer", "format": "int32" }, "totalSpent": { "type": "number", "format": "double" }, "originatingOutletId": { "type": "string", "format": "uuid", "nullable": true }, "originatingOutletName": { "type": "string", "nullable": true }, "originatingIntegrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.IntegrationTypes" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Companies.Queries.List.ListCompanyResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Companies.Queries.List.CompanyModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DetailDiscountQueryResponse": { "type": "object", "properties": { "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DiscountModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "allowMultipleUses": { "type": "boolean" }, "outlets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "validPeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PeriodModel" } ], "description": "The period this discount is valid for. Null means it's always valid.", "nullable": true }, "validDayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ], "description": "The day of weeks this discount is valid for." }, "validTimePeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.TimePeriodModel" } ], "description": "The time period this discount is valid for. Null means it's valid all day.\nFrom time is in UTC format.", "nullable": true }, "allValue": { "type": "number", "description": "The discount value that will be applied to everything.\nIf null then only the products or product groups specified in the Ancon.Wildcat.Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DiscountModel.Products and Ancon.Wildcat.Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.DiscountModel.ProductGroups will be discounted.", "format": "double", "nullable": true }, "discountType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] }, "discountAvailabilities": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Discounts.DiscountAvailabilities" } ], "description": "Gets the systems this discount is available for." }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.ProductDiscountModel" }, "description": "Gets which products this discount will work for.", "nullable": true }, "productGroups": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.ProductGroupDiscountModel" }, "description": "Gets which product groups this discount will work for.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.ProductDiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.Detail.ProductGroupDiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.List.ListDiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "timesUsed": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "validPeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PeriodModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Discounts.Queries.List.ListDiscountQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Discounts.Queries.List.ListDiscountModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.FeeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "amountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "isDeleted": { "type": "boolean" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.TaxModel" }, "nullable": true }, "outletFeeSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.OutletFeeSettingsModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.OutletFeeSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "outletName": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.Queries.Detail.DetailFeeQueryResponse": { "type": "object", "properties": { "fee": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.FeeModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.Queries.List.FeeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.Queries.List.ListFeeQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Fees.Queries.List.FeeModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Fees.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Integrations.PublicApi.Queries.Detail.Current.DetailCurrentApiTokenQueryResponse": { "type": "object", "properties": { "apiToken": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.ApiTokenModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.DetailMenuTreeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "isMandatory": { "type": "boolean", "readOnly": true }, "menuTreeItems": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.ProductModel" }, { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.MenuTreeBranchItemModel" } ] }, "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.MenuTreeBranchItemModel": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.MenuTreeItemModel" }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.MenuTreeItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "menuTreeItemType": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.MenuTrees.MenuTreeItemTypes" } ] }, "menuTreeBranchId": { "type": "string", "format": "uuid", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.ProductModel": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Detail.MenuTreeItemModel" }, { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productName": { "type": "string", "nullable": true }, "productDescription": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.HierarchyMenuTreeResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isMandatory": { "type": "boolean" }, "menuTreeItems": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductModel" }, { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeBranchItemModel" } ] }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeBranchItemModel": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeItemModel" }, { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductModel" }, { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeBranchItemModel" } ] }, "nullable": true }, "contentType": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.MenuTreeBranchContentTypes" } ] } }, "additionalProperties": false } ] }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "menuTreeItemType": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.MenuTrees.MenuTreeItemTypes" } ] }, "menuTreeBranchId": { "type": "string", "format": "uuid", "nullable": true }, "backgroundColor": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductGroupTagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Tags.TagTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductModel": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.MenuTreeItemModel" }, { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productName": { "type": "string", "nullable": true }, "imageId": { "type": "string", "format": "uuid", "nullable": true }, "productDescription": { "type": "string", "nullable": true }, "mainVariantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.VariantPriceModel" } ], "nullable": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "productStockCounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductStockCountModel" }, "nullable": true }, "productTags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductTagModel" }, "nullable": true }, "productGroupTags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductGroupTagModel" }, "nullable": true } }, "additionalProperties": false } ] }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductStockCountModel": { "type": "object", "properties": { "stockProductId": { "type": "string", "format": "uuid", "nullable": true }, "count": { "type": "number", "format": "double", "nullable": true }, "reorderCount": { "type": "number", "format": "double", "nullable": true }, "variantId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.ProductTagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tagId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Tags.TagTypes" } ] }, "outletId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.Hierarchy.VariantPriceModel": { "type": "object", "properties": { "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true }, "pricePresetName": { "type": "string", "nullable": true }, "showPricePresetLabel": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.List.ListMenuTreesQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MenuTrees.Queries.List.MenuTreeModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.List.MenuTreeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.MenuTrees.MenuTreeTypes" } ] }, "isMandatory": { "type": "boolean" }, "outletId": { "type": "string", "format": "uuid", "nullable": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MenuTrees.Queries.MenuTreeBranchContentTypes": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Create.CreateMetadataTemplateCommand": { "required": [ "data", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Metadatas.MetadataTypes" } ] }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Create.CreateMetadataTemplateCommandResponse": { "type": "object", "properties": { "metaDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.MetadataTemplateModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Update.UpdateMetadataTemplateCommand": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Commands.Update.UpdateMetadataTemplateCommandResponse": { "type": "object", "properties": { "metaDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.MetadataTemplateModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.MetadataTemplateModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Metadatas.MetadataTypes" } ] }, "isDeleted": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "deleted": { "type": "string", "format": "date-time", "nullable": true }, "tenantId": { "type": "string", "format": "uuid" }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Queries.Detail.DetailMetadataTemplateQueryResponse": { "type": "object", "properties": { "metaDataTemplate": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.MetadataTemplateModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.MetadataTemplates.Queries.List.ListMetadataTemplateQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.MetadataTemplates.MetadataTemplateModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.ClientModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "clientType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ClientTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Create.CreateOutletClientGroupCommand": { "required": [ "costCenter", "name", "project" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of outlet client group" }, "costCenter": { "minLength": 1, "type": "string", "description": "CostCenter of outlet client group" }, "project": { "minLength": 1, "type": "string", "description": "Project of outlet client group" }, "clientIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of outlet clients", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Create.CreateOutletClientGroupCommandResponse": { "type": "object", "properties": { "clientGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.OutletClientGroupDetailsModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Update.UpdateOutletClientGroupCommand": { "required": [ "costCenter", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of outlet client group" }, "costCenter": { "minLength": 1, "type": "string", "description": "CostCenter of outlet client group" }, "project": { "type": "string", "description": "Project of outlet client group", "nullable": true }, "clientIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Ids of outlet clients", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Commands.Update.UpdateOutletClientGroupCommandResponse": { "type": "object", "properties": { "clientGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.OutletClientGroupDetailsModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.OutletClientGroupDetailsModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "outletId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "costCenter": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.ClientModel" }, "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.Detail.DetailOutletClientGroupQueryResponse": { "type": "object", "properties": { "clientGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.OutletClientGroupDetailsModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.List.ClientGroupListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "outletId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "costCenter": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.List.ListOutletClientGroupQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.ClientGroups.Queries.List.ClientGroupListModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Clients.Queries.List.ClientModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "lastOnline": { "type": "string", "format": "date-time" }, "clientType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ClientTypes" } ] }, "isLinked": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Clients.Queries.List.ListClientsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Clients.Queries.List.ClientModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OrderFormatSettingsModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "preparationTime": { "type": "string", "format": "date-span" }, "options": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.OrderFormatOptions" } ] }, "minimumOrder": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "aoTippingPercentages": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AOTippingPercentages" } ], "nullable": true }, "collectionTicketTimerMinutes": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletDeliveryAreaModel": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LocationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletOpeningHoursModel": { "required": [ "isDefault", "orderFormat", "position", "state", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.HoursTypes" } ] }, "state": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OpeningHoursStates" } ] }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "dayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ] }, "period": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TPeriodModel" } ], "nullable": true }, "timePeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TTimePeriodModel" } ], "nullable": true }, "reason": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletReceiptSettingsModel": { "type": "object", "properties": { "text": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "logoId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TPeriodModel": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TTimePeriodModel": { "type": "object", "properties": { "from": { "type": "string", "format": "time" }, "duration": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TipSettingsModel": { "type": "object", "properties": { "showTipAs": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ShowTipAs" } ] }, "reduceAmountOn": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ReduceAmountOn" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.UpdateOutletCommand": { "type": "object", "properties": { "tenantId": { "type": "string", "format": "uuid" }, "openingHours": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletOpeningHoursModel" }, "nullable": true }, "blockedVisibilities": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.BlockedVisibilities" } ] }, "verificationSeries": { "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "tip": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.TipSettingsModel" } ], "nullable": true }, "autoOrderVoucherBasisTime": { "type": "string", "format": "time" }, "generateAutoOrderVoucherBasis": { "type": "boolean" }, "smsSenderId": { "pattern": "^[a-zA-Z \\d]{1,11}$", "type": "string", "nullable": true }, "autoAcceptOrders": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AutoAcceptOrderModes" } ] }, "deliveryArea": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletDeliveryAreaModel" } ], "nullable": true }, "supportedOrderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "orderFormatSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OrderFormatSettingsModel" }, "nullable": true }, "receiptSettings": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.OutletReceiptSettingsModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Commands.Update.UpdateOutletCommandResponse": { "type": "object", "properties": { "outlet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OutletModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.OrderFormatSettingsModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "preparationTime": { "type": "string", "format": "date-span", "readOnly": true }, "options": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.OrderFormatOptions" } ], "readOnly": true }, "minimumOrder": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "aoTippingPercentages": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AOTippingPercentages" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.OutletDeliveryAreaModel": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LocationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.OutletModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "businessNumber": { "type": "string", "nullable": true, "readOnly": true }, "timeZoneOffset": { "type": "string", "format": "date-span", "readOnly": true }, "openingHours": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OutletOpeningHoursModel" }, "nullable": true, "readOnly": true }, "deliveryArea": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OutletDeliveryAreaModel" } ], "nullable": true, "readOnly": true }, "blockedVisibilities": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.BlockedVisibilities" } ], "readOnly": true }, "verificationSeries": { "type": "string", "nullable": true, "readOnly": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true, "readOnly": true }, "tip": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.TipSettingsModel" } ], "nullable": true, "readOnly": true }, "autoOrderVoucherBasisTime": { "type": "string", "format": "time", "readOnly": true }, "generateAutoOrderVoucherBasis": { "type": "boolean", "readOnly": true }, "smsSenderId": { "type": "string", "nullable": true, "readOnly": true }, "autoAcceptOrderMode": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AutoAcceptOrderModes" } ], "readOnly": true }, "supportedOrderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderFormatSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OrderFormatSettingsModel" }, "nullable": true, "readOnly": true }, "receiptSettings": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OutletReceiptSettingsModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.OutletOpeningHoursModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.HoursTypes" } ], "readOnly": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OpeningHoursStates" } ], "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "dayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ], "readOnly": true }, "unformattedPeriodFrom": { "type": "string", "format": "date-time", "readOnly": true }, "periodFrom": { "type": "string", "nullable": true, "readOnly": true }, "unformattedPeriodTo": { "type": "string", "format": "date-time", "readOnly": true }, "periodTo": { "type": "string", "nullable": true, "readOnly": true }, "from": { "type": "string", "description": "From time is in UTC format", "format": "date-span", "readOnly": true }, "duration": { "type": "string", "format": "date-span", "readOnly": true }, "reason": { "type": "string", "nullable": true, "readOnly": true }, "isDefault": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.OutletReceiptSettingsModel": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "logoId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Queries.Detail.DetailOutletQueryResponse": { "type": "object", "properties": { "outlet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.OutletModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.List.ListSectionQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.List.SectionModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.List.SectionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "tableMapActive": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "tableCount": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.CheckModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.StatusSectionQueryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "tables": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.TableModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "number": { "type": "integer", "format": "int64", "readOnly": true }, "checks": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Sections.Queries.Status.CheckModel" }, "nullable": true, "readOnly": true }, "hasMaitresCustomer": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "externalId": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.UpdateTableExternalIdCommand": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "tableId": { "type": "string", "format": "uuid" }, "externalid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.UpdateTableExternalIdCommandResponse": { "type": "object", "properties": { "table": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Tables.Commands.Update.ExternalId.TableModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Tables.Queries.List.ListTablesQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Outlets.Tables.Queries.List.TableModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.Tables.Queries.List.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "format": "int32" }, "sectionName": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Outlets.TipSettingsModel": { "type": "object", "properties": { "showTipAs": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ShowTipAs" } ] }, "reduceAmountOn": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ReduceAmountOn" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.AccountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "number": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Create.CreateProductGroupCommand": { "required": [ "name", "outletProductGroupSettings" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TaxModel" }, "nullable": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.OutletProductGroupSettingsModel" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TagModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Create.CreateProductGroupCommandResponse": { "type": "object", "properties": { "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.ProductGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.OutletProductGroupSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "accountNumber": { "pattern": "^(?:[0-9]{1,4})$", "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TaxModel": { "required": [ "orderFormats" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Update.UpdateProductGroupCommand": { "required": [ "name", "outletProductGroupSettings" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TaxModel" }, "nullable": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.OutletProductGroupSettingsModel" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Commands.TagModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Commands.Update.UpdateProductGroupCommandResponse": { "type": "object", "properties": { "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.ProductGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.OutletProductGroupSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "outletName": { "type": "string", "nullable": true, "readOnly": true }, "accountNumber": { "type": "string", "nullable": true, "readOnly": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true, "readOnly": true }, "custom1": { "type": "string", "nullable": true, "readOnly": true }, "custom2": { "type": "string", "nullable": true, "readOnly": true }, "custom3": { "type": "string", "nullable": true, "readOnly": true }, "custom4": { "type": "string", "nullable": true, "readOnly": true }, "custom5": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.ProductGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductGroupTypes" } ], "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.TaxModel" }, "nullable": true, "readOnly": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.AccountModel" }, "nullable": true, "readOnly": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.OutletProductGroupSettingsModel" }, "nullable": true, "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Queries.Detail.DetailProductGroupQueryResponse": { "type": "object", "properties": { "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.ProductGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Queries.List.ListProductGroupQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.Queries.List.ProductGroupListModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.Queries.List.ProductGroupListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductGroupTypes" } ], "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.ProductGroups.TaxModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.ProductGroups.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "rate": { "type": "number", "format": "double", "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.AddOnGroups.AddOnGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "Name of the add-on group. The name is used to easily identify the group.", "nullable": true }, "minimumAmount": { "type": "number", "description": "Minimum amount of ingredients from this group you must add to the order.\n0 means it has no minimum amount.", "format": "double" }, "maximumAmount": { "type": "number", "description": "Maximum amount of ingredients from this group you are allowed to add to the order.\n0 means it has no maximum amount.", "format": "double" }, "allowMultiple": { "type": "boolean", "description": "A value indicating whether to allow multiple of the same ingredients from this group to be added to the order." }, "freeAmount": { "type": "number", "description": "Aount of ingredients that will be free of charge from this group.\n0 menas it has no free ingredients and the normal ingredient prices will be used.", "format": "double" }, "afterFreePrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Price that will be set for all ingredients that exceedes the 'FreeAmount'.\nIf 'FreeAmount' is 0 then this price will not be used.", "nullable": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.AddOnGroups.IngredientModel" }, "description": "List of of ingredients and their prices.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.AddOnGroups.IngredientModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "position": { "type": "integer", "description": "Sorting position of the ingredient in the group", "format": "int32" }, "hasOwnPrice": { "type": "boolean", "description": "Whether the connected ingredient price is overriden for this add-on group.\nIf this is set to false the price from the ingredient will be used." }, "defaultPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "The default price on the ingredient, used if 'HasOwnPrice' is false", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "The overriden price for the connected ingredient, used if 'HasOwnPrice' is true", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.Detail.DetailAddOnGroupResponse": { "type": "object", "properties": { "addOnGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.AddOnGroups.AddOnGroupModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.List.AddOnGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.List.ListAddOnGroupQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.AddOnGroups.Queries.List.AddOnGroupModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Availabilities.Commands.Update.UpdateProductAvailabilitiesCommand": { "required": [ "availabilities" ], "type": "object", "properties": { "availabilities": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Commands.ProductAvailabilitiesModel" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.Create.CreateProductCommand": { "required": [ "name", "productGroupId" ], "type": "object", "properties": { "productGroupId": { "type": "string", "description": "Product group id for this product", "format": "uuid" }, "productOutletId": { "type": "string", "description": "Outlet id this product belongs to", "format": "uuid", "nullable": true }, "name": { "maxLength": 45, "minLength": 0, "type": "string", "description": "Name of the product" }, "description": { "type": "string", "description": "Description of the product", "nullable": true }, "allergyInformation": { "type": "string", "description": "Allergy information for the product if any is available.\nFor example (Contains traces of peanuts)", "nullable": true }, "hasVariants": { "type": "boolean", "description": "True means ths product has more than one variants for example a product named Coca-Cola can have two variants: 33cl, 50cl.\nFalse means that there will only be one variant" }, "mandatoryToPickVariant": { "type": "boolean", "description": "Gets a value indicating whether if it is mandatory to select variant instead of default selection.\nThis applies only for standard products and when there are more than one variants." }, "autoAccept": { "type": "boolean", "description": "Gets a value indicating whether auto accept mode is enabled for the product." }, "availableInAllOutlets": { "type": "boolean", "description": "If true will make the product shared with all outlets within the tenant" }, "flowViewEnabled": { "type": "boolean", "description": "Gets a value indicating whether the flowview enabled for the product.\nDefault value will be false (which means AccordianView).\nThis should be only applicable to Standard Products and only available in POS." }, "courseId": { "type": "string", "description": "Optional course id this product will have by default when added to a check", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.Create.CreateProductCommandResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.Metadata.MetadataProductCommand": { "required": [ "data", "metadataTemplateId" ], "type": "object", "properties": { "metadataTemplateId": { "type": "string", "format": "uuid" }, "data": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.ProductAvailabilitiesModel": { "type": "object", "properties": { "systemVisibility": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Products.SystemVisibilities" } ] }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.Tags.ProductTagCommand": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Commands.Update.UpdateProductCommand": { "required": [ "name", "productGroupId" ], "type": "object", "properties": { "productGroupId": { "type": "string", "format": "uuid" }, "name": { "maxLength": 45, "minLength": 0, "type": "string" }, "description": { "type": "string", "nullable": true }, "allergyInformation": { "type": "string", "nullable": true }, "hasVariants": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.Detail.DetailIngredientsQueryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.List.IngredientModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.List.ListIngredientsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Ingredients.Queries.List.IngredientModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.Detail.DetailProductQueryResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "surrogateId": { "type": "string", "format": "uuid", "readOnly": true }, "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "allergyInformation": { "type": "string", "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.TaxModel" }, "nullable": true, "readOnly": true }, "productAvailabilities": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.Detail.ProductAvailabilityModel" }, "nullable": true, "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "mandatoryToPickVariant": { "type": "boolean", "readOnly": true }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.Detail.VariantModel" }, "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.TagModel" }, "nullable": true, "readOnly": true }, "subProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.Detail.SubProductModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.Detail.ProductAvailabilityModel": { "type": "object", "properties": { "systemVisibility": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Products.SystemVisibilities" } ] }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.Detail.SubProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "productId": { "type": "string", "format": "uuid", "readOnly": true }, "variantId": { "type": "string", "format": "uuid", "readOnly": true }, "variantName": { "type": "string", "nullable": true, "readOnly": true }, "useOverridePrice": { "type": "boolean", "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.ItemPriceModel" } ], "nullable": true, "readOnly": true }, "overridePrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.ItemPriceModel" } ], "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "outletShares": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.TaxModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.Detail.VariantModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isMainProductVariant": { "type": "boolean" }, "isOpenPrice": { "type": "boolean" }, "variantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.ItemPriceModel": { "type": "object", "properties": { "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.List.ListProductQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.List.ProductModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.List.ProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "surrogateId": { "type": "string", "format": "uuid", "readOnly": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ], "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "allergyInformation": { "type": "string", "nullable": true, "readOnly": true }, "image": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true, "readOnly": true }, "mandatoryToPickVariant": { "type": "boolean", "readOnly": true }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.List.VariantModel" }, "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Queries.TagModel" }, "nullable": true, "readOnly": true }, "metadata": { "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.List.VariantModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "isMainProductVariant": { "type": "boolean", "readOnly": true }, "useBasePrice": { "type": "boolean", "readOnly": true }, "isOpenPrice": { "type": "boolean", "readOnly": true }, "variantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "hasPricePresets": { "type": "boolean", "readOnly": true }, "hasPriceOverrides": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.TagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Tags.TagTypes" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Queries.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "taxType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Shares.Commands.Update.UpdateProductSharesCommand": { "required": [ "outletShareIds" ], "type": "object", "properties": { "outletShareIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.UnitPriceModel": { "type": "object", "properties": { "unitPrice": { "type": "number", "description": "Gets or sets the price per unit.\nFor example 10 per piece. Or 50 per cl. It depends on the unit of the product.", "format": "double" }, "additionalPrice": { "type": "number", "description": "Gets or sets the additional price.\nFor example 50 per cl + 10 additional price.", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.Update.SubProductModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the sub product that you want to edit. Set this to null when adding new sub products.", "format": "uuid", "nullable": true }, "productId": { "type": "string", "description": "The id of the product that you want to use as a sub product.", "format": "uuid" }, "productVariantId": { "type": "string", "description": "The optional id of a specific product variant that you want to use.\nUsually this is set. If it's not set then the POS user will get a popup to pick a specific variant to add the check.", "format": "uuid", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.UnitPriceModel" } ], "description": "Override the price for this sub product. This price is used when is true.", "nullable": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.UnitPriceModel" } ], "description": "Override the material cost for this sub product. This price is used when is true.", "nullable": true }, "useOverridePrice": { "type": "boolean", "description": "Set this to true if you want to use a overrided price." }, "position": { "type": "integer", "description": "The position of this sub product, this is used to sort sub products on check, tickets, receipts etc.", "format": "int32" }, "quantity": { "maximum": 99, "minimum": 1, "type": "number", "description": "This is the quantity of the sub product to be added to the check.", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.Update.UpdateSubProductCommand": { "type": "object", "properties": { "addedSubProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.Update.SubProductModel" }, "description": "List of sub products to add.", "nullable": true }, "updatedSubProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.SubProducts.Commands.Update.SubProductModel" }, "description": "List of sub products you want to update.", "nullable": true }, "deletedSubProducts": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of sub product ids you want to delete.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.Detail.DetailUpsellGroupQueryResponse": { "type": "object", "properties": { "upsellGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.UpsellGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.List.ListUpsellGroupQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.List.UpsellGroupModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.Queries.List.UpsellGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.StockModel": { "type": "object", "properties": { "stockProductId": { "type": "string", "format": "uuid", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "productVariantId": { "type": "string", "format": "uuid", "readOnly": true }, "count": { "type": "number", "format": "double", "readOnly": true }, "reorderCount": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.UpsellGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.UpsellGroupProductQueryModel" }, "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.UpsellGroups.UpsellGroupProductQueryModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "productId": { "type": "string", "format": "uuid", "readOnly": true }, "variantId": { "type": "string", "format": "uuid", "readOnly": true }, "productName": { "type": "string", "nullable": true, "readOnly": true }, "variantName": { "type": "string", "nullable": true, "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "hasOwnPrice": { "type": "boolean", "readOnly": true }, "defaultPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "outletStocks": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.UpsellGroups.StockModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Variants.Commands.Create.CreateVariantCommand": { "required": [ "isMainProductVariant", "isOpenPrice", "name", "position", "variantPrice" ], "type": "object", "properties": { "name": { "maxLength": 60, "minLength": 0, "type": "string" }, "isMainProductVariant": { "type": "boolean" }, "isOpenPrice": { "type": "boolean" }, "variantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.VariantPriceModel" } ] }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.VariantPriceModel" } ], "nullable": true }, "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Variants.Commands.Update.UpdateVariantCommand": { "required": [ "isMainProductVariant", "isOpenPrice", "name", "position", "variantPrice" ], "type": "object", "properties": { "name": { "maxLength": 60, "minLength": 0, "type": "string" }, "isMainProductVariant": { "type": "boolean" }, "isOpenPrice": { "type": "boolean" }, "variantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.VariantPriceModel" } ] }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Products.Variants.Commands.VariantPriceModel" } ], "nullable": true }, "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Products.Variants.Commands.VariantPriceModel": { "type": "object", "properties": { "unitPrice": { "type": "number", "description": "Gets or sets the price per unit.\nFor example 10 per piece. Or 50 per cl. It depends on the unit of the product.", "format": "double" }, "additionalPrice": { "type": "number", "description": "Gets or sets the additional price.\nFor example 50 per cl + 10 additional price.", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.SaleSources.Queries.List.ListSaleSourceQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.SaleSources.Queries.List.SaleSourceModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.SaleSources.Queries.List.SaleSourceModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "tenantId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "apiTokenId": { "type": "string", "format": "uuid", "nullable": true }, "deleted": { "type": "string", "format": "date-time", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SaleSourceTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.CancelInfoModel": { "type": "object", "properties": { "actor": { "type": "string", "nullable": true }, "actorId": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "reasonDesc": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutFeeModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "feeId": { "type": "string", "format": "uuid", "readOnly": true }, "feeName": { "type": "string", "nullable": true, "readOnly": true }, "amountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "amountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.TaxModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "checkoutId": { "type": "string", "format": "uuid", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.OrderedProductModel" } ], "nullable": true, "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "unitQuantity": { "type": "number", "format": "double", "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.UnitModel" } ], "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountValueModel" } ], "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.TaxModel" }, "nullable": true, "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ModificationModel" }, "nullable": true, "readOnly": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "discountAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "stock": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.StockModel" } ], "nullable": true, "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "incrementalNumbers": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.IncrementalNumbersModel" } ], "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "outlet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.SalesLocationInfoModel" } ], "nullable": true, "readOnly": true }, "table": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.TableModel" } ], "nullable": true, "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountModel" } ], "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckoutStatuses" } ], "readOnly": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.CustomerInfoModel" } ], "nullable": true, "readOnly": true }, "delivery": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.DeliveryModel" } ], "nullable": true, "readOnly": true }, "instructions": { "type": "string", "nullable": true, "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "serviceTime": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel" } ], "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.", "nullable": true, "readOnly": true }, "source": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "saleSourceId": { "type": "string", "format": "uuid", "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "authorizedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "capturedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "canceledAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "cancelInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CancelInfoModel" } ], "nullable": true, "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "taxAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subtotalInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subtotalExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subTotalDiscountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subTotalDiscountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "feeAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "feeAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "minimumOrderDifferenceAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "summary": { "type": "string", "nullable": true, "readOnly": true }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "minimumOrderAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutItemModel" }, "nullable": true, "readOnly": true }, "fees": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutFeeModel" }, "nullable": true, "readOnly": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.PaymentModel" }, "nullable": true, "readOnly": true }, "tickets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutTicketModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutTicketModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TicketStatuses" } ], "readOnly": true }, "preparationTime": { "type": "string", "nullable": true, "readOnly": true }, "ticketId": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ApplyDiscount.ApplyDiscountCheckoutCommand": { "required": [ "code" ], "type": "object", "properties": { "code": { "maxLength": 10, "minLength": 1, "pattern": "^[a-zåäöA-ZÅÄÖ0-9!_.-]*$", "type": "string" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ApplyDiscount.ApplyDiscountCheckoutCommandResponse": { "type": "object", "properties": { "checkout": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.CheckoutItemModel": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "quantity": { "type": "integer", "format": "int32" }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ModificationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.Create.CreateCheckoutCommand": { "required": [ "items", "orderFormat", "serviceTime" ], "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "serviceTime": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel" } ], "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side." }, "delivery": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.DeliveryModel" } ], "nullable": true }, "instructions": { "type": "string", "nullable": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.SalesLocationInfoModel" } ], "description": "Sales location is only needed for order format TableOrder, then it should be set to the table id.\nFor other order formats it can be null.", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.CheckoutItemModel" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.Create.CreateCheckoutCommandResponse": { "type": "object", "properties": { "checkout": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.ModificationModel": { "type": "object", "properties": { "modification": { "type": "string", "description": "Type of modification can be one of the following values \"add\", \"remove\" or \"replace\"", "nullable": true }, "ingredientId": { "type": "string", "description": "Add: The ingredient to be added.\nRemove: The ingredient to be removed.\nReplace: The ingredient that will be replaced.", "format": "uuid", "nullable": true }, "addOnGroupId": { "type": "string", "description": "The add-on group id, used by modificaiton \"add\"", "format": "uuid", "nullable": true }, "replaceId": { "type": "string", "description": "The replacement ingredient that will be used instead.", "format": "uuid", "nullable": true }, "quantity": { "type": "number", "description": "How many modifications to add of the given ingredientId, used by modification \"add\".", "format": "double" }, "freeAmount": { "type": "number", "description": "How many modificaitons to add that will count as free, used by modification \"add\".\nCannot be more than quantity.\nThis must follow the rules of the add-on group, free amount cannot be more than allowed per the add-on group configuration", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Commands.RecalculatePrices.RecalculateCheckoutPricesCommandResponse": { "type": "object", "properties": { "checkout": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.PaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckoutPaymentStatuses" } ], "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "provider": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentProviderType" } ], "readOnly": true }, "method": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PaymentMethodModel" } ], "nullable": true, "readOnly": true }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.TransactionModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.CustomerInfoModel": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "minLength": 1, "type": "string" }, "lastName": { "minLength": 1, "type": "string" }, "email": { "minLength": 1, "type": "string" }, "languageCode": { "type": "string", "nullable": true }, "telephoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.PaymentCreateCompletedCommand": { "required": [ "amount", "customer", "transactionData", "transactionDate", "transactionId" ], "type": "object", "properties": { "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Paid amount, must match the total amount of the checkout." }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.CustomerInfoModel" } ] }, "transactionDate": { "type": "string", "description": "Transaction date will be set to the checkout payment, should match a date time on the integrator side.", "format": "date-time" }, "transactionId": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Transaction id of the payment, should match a id on integrator side." }, "transactionData": { "minLength": 1, "type": "string", "description": "Transaction data of the payment, should contain information about the transaction." }, "addtionalTransactionData": { "type": "string", "description": "Optional addtional data for the transaction.", "nullable": true, "deprecated": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Payments.Commands.CreateCompleted.PaymentCreateCompletedCommandResponse": { "type": "object", "properties": { "checkout": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.Queries.Details.DetailCheckoutQueryResponse": { "type": "object", "properties": { "checkout": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checkouts.CheckoutModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.StockModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "format": "uuid" }, "variantId": { "type": "string", "format": "uuid" }, "count": { "type": "number", "format": "double" }, "reorderCount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checkouts.TransactionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckoutTransactionTypes" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckoutTransactionStatuses" } ] }, "providerTransactionId": { "type": "string", "nullable": true }, "providerDataJson": { "type": "string", "nullable": true }, "errorDetails": { "type": "string", "nullable": true }, "notificationJson": { "type": "string", "nullable": true }, "paymentProviderCode": { "type": "string", "nullable": true, "deprecated": true }, "paymentProviderData": { "type": "string", "nullable": true, "deprecated": true }, "notificationReceived": { "type": "boolean", "deprecated": true }, "providerAdditionalData": { "type": "string", "nullable": true, "deprecated": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "checkId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyOrderedProduct" } ], "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared OrderedProduct as it serializes in the\nproduction package (1.0.1200-alpha). The current package marks IsSystemProduct with\n[JsonIgnore], which would silently drop the field from the legacy payloads, so the raw\nvalue object cannot be serialized directly anymore. Frozen - do not change.", "nullable": true, "readOnly": true }, "quantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unitQuantity": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Quantity" } ], "nullable": true, "readOnly": true }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Unit" } ], "nullable": true, "readOnly": true }, "pricePresetId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PricePerUnitMoney" } ], "nullable": true, "readOnly": true }, "kitchenMessage": { "type": "string", "nullable": true, "readOnly": true }, "discountInfo": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountInfo" } ], "nullable": true, "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountValue" } ], "nullable": true, "readOnly": true }, "courseName": { "type": "string", "nullable": true, "readOnly": true }, "coursePosition": { "type": "integer", "format": "int32", "readOnly": true }, "checkPaymentId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "paidAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "tag": { "type": "string", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckItemStatuses" } ], "readOnly": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "ticketedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ticketedTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.ModificationModel" }, "nullable": true, "readOnly": true }, "isTaxMandatory": { "type": "boolean", "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.TaxModel" }, "nullable": true, "readOnly": true }, "checkItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true, "readOnly": true }, "parentItemId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "isMultiproduct": { "type": "boolean", "readOnly": true }, "hasOwnPrice": { "type": "boolean", "readOnly": true }, "priceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "priceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "discountAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalDiscountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "totalDiscountAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "modificationPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "modificationPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "isPrepaid": { "type": "boolean", "readOnly": true } }, "additionalProperties": false, "description": "Public api 1.0 check item, serialized as it was before R18: the product keeps IsSystemProduct,\nunit prices are Money objects and sub items are nested check items with ParentItemId set." }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemPriceModel": { "type": "object", "properties": { "unitPrice": { "type": "number", "format": "double" }, "additionalPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItems.Commands.Split.SplitCheckItemCommand": { "required": [ "checkItemIds", "parts" ], "type": "object", "properties": { "parts": { "maximum": 100, "minimum": 2, "type": "integer", "format": "int32" }, "checkItemIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItems.Commands.Split.SplitCheckItemCommandResponse": { "type": "object", "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckMetadataModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkId": { "type": "string", "format": "uuid" }, "checkItemId": { "type": "string", "description": "Rename for next version to string 'Reference'", "format": "uuid", "nullable": true, "readOnly": true, "deprecated": true }, "metaData": { "description": "Rename for next version to 'Metadata'", "nullable": true, "deprecated": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "outlet": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.IdName" } ], "nullable": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "saleSourceId": { "type": "string", "format": "uuid", "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountValue" } ], "nullable": true, "readOnly": true }, "discountCode": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.DiscountInfo" } ], "nullable": true, "readOnly": true }, "currency": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.CurrencyCode" } ], "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.SalesLocationInfoModel" } ], "nullable": true, "readOnly": true }, "companyInfo": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.CompanyInfo" } ], "nullable": true, "readOnly": true }, "deletedReason": { "type": "string", "nullable": true, "readOnly": true }, "createdCheckTenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "createdCheckTenantUser": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.ValueObjects.UserWithEmail" } ], "nullable": true }, "closedCheckTenantUserId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckClientId": { "type": "string", "format": "uuid", "readOnly": true }, "closedCheckClientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "incrementalNumbers": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.IncrementalNumbersModel" } ], "nullable": true, "readOnly": true }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "deleted": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "guestCount": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "metaData": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckMetadataModel" }, "description": "Rename for next version to 'Metadata'", "nullable": true, "readOnly": true, "deprecated": true }, "checkItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true, "readOnly": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckPaymentModel" }, "nullable": true, "readOnly": true }, "allCheckItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true, "readOnly": true }, "itemsExclSystemProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemModel" }, "nullable": true, "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "totalAmountPlusTip": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "taxAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "subtotalInclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "subtotalExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "subTotalDiscountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "subTotalDiscountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "remainingAmountToPay": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true, "readOnly": true }, "awaitingConfirmation": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.CustomerInfo" } ], "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2." }, "Core.Api.Models.Public.V1.V0.Sales.Checks.CheckPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "paymentType": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PaymentTypes" } ], "readOnly": true }, "paymentMethod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PaymentMethodModel" } ], "nullable": true, "readOnly": true }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "cashBackAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "roundingAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "tipAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "tenantUserId": { "type": "string", "format": "uuid", "readOnly": true }, "externalReference": { "type": "string", "nullable": true, "readOnly": true }, "externalIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CheckPaymentStatuses" } ], "readOnly": true }, "errorType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.CardPaymentErrorTypes" } ], "nullable": true, "readOnly": true }, "terminal": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true }, "client": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true }, "centralControlUnitSerial": { "type": "string", "nullable": true, "readOnly": true }, "receipts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ReceiptModel" }, "nullable": true, "readOnly": true }, "invoiceReferenceNote": { "type": "string", "nullable": true, "readOnly": true }, "isReceiptPrinted": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemCheckCommand": { "required": [ "item" ], "type": "object", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemItemModel" } ] }, "courseId": { "type": "string", "format": "uuid", "nullable": true }, "checkId": { "type": "string", "format": "uuid", "nullable": true }, "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.CheckCreateModel" } ], "nullable": true }, "isPrepaid": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemCheckResponse": { "type": "object", "properties": { "checkItem": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.CheckItemModel" } ], "description": "Restored 1.0 wire shape of the old domain CheckItemDto as serialized inside the legacy\nCheckPaidEvent websocket payload on alpha/production (before the check item domain was\nrestructured into CheckItemDto/SubCheckItemDto). Frozen - do not change the serialized surface.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.AddItemItemModel": { "required": [ "quantity", "variantId" ], "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid" }, "quantity": { "maximum": 100000, "minimum": -100000, "type": "number", "format": "double" }, "kitchenMessage": { "maxLength": 100, "type": "string", "nullable": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckItemPriceModel" } ], "nullable": true }, "upsellGroupId": { "type": "string", "format": "uuid", "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.ProductItemModificationModel" }, "nullable": true }, "tag": { "maxLength": 256, "type": "string", "nullable": true }, "subProductSpecification": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.SubProductSpecificationModel" }, "description": "Gets or sets the list of sub product specifications. It is used when adding a multi product with sub product with optional variant(s).\nIn those cases the API user has to select a variant.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.CheckCreateModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] }, "salesLocationId": { "type": "string", "format": "uuid" }, "guestCount": { "type": "integer", "format": "int32", "nullable": true }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true }, "externalTableId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.ProductItemModificationModel": { "type": "object", "properties": { "modification": { "type": "string", "nullable": true }, "ingredientId": { "type": "string", "format": "uuid", "nullable": true }, "addOnGroupId": { "type": "string", "format": "uuid", "nullable": true }, "replaceId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "freeAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.AddItem.SubProductSpecificationModel": { "type": "object", "properties": { "subProductId": { "type": "string", "description": "Gets or sets the Id of the sub product. A sub product can be be configured in Admin to point to a product and optionally a specific variant.\nSo in some cases the API user has to specify which variant should be added as a sub product.", "format": "uuid" }, "subProductVariantId": { "type": "string", "description": "Gets or sets the id of the variant to be used for this subproduct.", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Create.CreateCheckCommand": { "required": [ "orderFormat", "salesLocationType" ], "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] }, "salesLocationId": { "type": "string", "format": "uuid" }, "collectionTicketId": { "type": "string", "format": "uuid", "nullable": true }, "guestCount": { "maximum": 999, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "externalTableId": { "type": "string", "nullable": true }, "customName": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Create.CreateCheckCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomName.UpdateCheckCustomNameCommand": { "type": "object", "properties": { "customName": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomName.UpdateCheckCustomNameCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommand": { "type": "object", "properties": { "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.CustomTicket.UpdateCheckCustomTicketNumberCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Delete.DeleteCheckCommand": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Delete.DeleteCheckCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Discount.DiscountCheckCommand": { "type": "object", "properties": { "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Discount.DiscountValueModel" } ], "nullable": true }, "code": { "maxLength": 10, "pattern": "^[a-zåäöA-ZÅÄÖ0-9!_.-]*$", "type": "string", "nullable": true }, "discountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Discount.DiscountValueModel": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Move.MoveCheckCommand": { "required": [ "salesLocationType" ], "type": "object", "properties": { "salesLocationId": { "type": "string", "format": "uuid" }, "salesLocationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Move.MoveCheckCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Split.SplitCheckCommand": { "required": [ "parts" ], "type": "object", "properties": { "parts": { "maximum": 100, "minimum": 2, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Commands.Split.SplitCheckCommandResponse": { "type": "object", "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" }, "nullable": true }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.NameModel": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommand": { "required": [ "tableReservationMetadata" ], "type": "object", "properties": { "tableReservationMetadata": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.TableReservationMetadataModel" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.SetTableReservationMetadataCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.TableReservationMetadataModel": { "type": "object", "properties": { "reservationArrivalDateTime": { "type": "string", "format": "date-time", "nullable": true }, "reservationEndDateTime": { "type": "string", "format": "date-time", "nullable": true }, "customerFirstName": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.NameModel" } ], "nullable": true }, "customerLastName": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Metadata.Commands.SetTableReservation.NameModel" } ], "nullable": true }, "customerEmail": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.EmailAddress" } ], "nullable": true }, "customerPhone": { "type": "string", "nullable": true }, "guestCount": { "type": "integer", "format": "int32", "nullable": true }, "reservationId": { "type": "string", "nullable": true }, "customNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.ModificationModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "checkItemId": { "type": "string", "format": "uuid", "readOnly": true }, "modification": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Events.DirectEventHandlers.MessageQueues.Sales.Checks.Models.V1.V0.Detail.LegacyProductModification" } ], "description": "Restored 1.0 wire shape of Ancon.Wildcat.Shared ProductModification as it serializes in the\nproduction package (1.0.1200-alpha), where Cost and MaterialCost are Money objects. The\ncurrent package flattened them to decimals, so the raw value object cannot be serialized\ndirectly anymore. Frozen - do not change.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommand": { "type": "object", "properties": { "paymentAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true }, "tipAmount": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true }, "externalReference": { "type": "string", "nullable": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Payments.Commands.CreateIntegrationPayment.CreateIntegrationCheckPaymentCommandResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Details.DetailCheckQueryResponse": { "type": "object", "properties": { "check": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckModel" } ], "description": "Public api 1.0 check. Third party integrations parse this shape and cannot be made to update,\nso it serializes exactly as it did before R18: the domain value objects (Money, CurrencyCode,\nDiscountInfo, CompanyInfo, CustomerInfo) go on the wire as they are. The current shape is\nserved by public api v2.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Outlets.CheckOutletModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "referenceNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "serialNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "metaData": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckMetadataModel" }, "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Outlets.ListCheckOutletQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.Outlets.CheckOutletModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.SalesLocation.CheckSalesLocationModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "referenceNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "serialNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "orderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "lingerWhenClosed": { "type": "boolean", "readOnly": true }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "metaData": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.CheckMetadataModel" }, "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.SalesLocation.ListCheckSalesLocationQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Checks.Queries.SalesLocation.CheckSalesLocationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Checks.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.UsedTax" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.CompanyInfoModel": { "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyBusinessNumber": { "type": "string", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.GeneralAddressModel" } ], "nullable": true }, "invoiceEmail": { "type": "string", "nullable": true }, "memberId": { "type": "string", "format": "uuid", "nullable": true }, "memberName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.CustomerInfoModel": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "identityUserId": { "type": "string", "format": "uuid", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.AddressModel" } ], "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.DeliveryInfoModel": { "type": "object", "properties": { "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.AddressModel" } ], "nullable": true }, "phone": { "type": "string", "nullable": true }, "recipient": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.DiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.DiscountValueModel": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.IncrementalNumbersModel": { "type": "object", "properties": { "ticketNumber": { "type": "integer", "description": "Unique number per outlet per Z-Report, it will reset when a Z-Report is made and start on 1 again.\nUsed alot in the UI to give a simple to read number, will also be printed on tickets.", "format": "int64", "nullable": true }, "serialNumber": { "type": "integer", "description": "Unbroken sequence per outlet which statisfies the needs of certain pos system laws, is only used on Checks.", "format": "int64", "nullable": true }, "referenceNumber": { "type": "integer", "description": "Unbroken sequence per outlet which is used for all types of sales.\nSuitable for correlation between systems.", "format": "int64", "nullable": true }, "refundSerialNumber": { "type": "integer", "description": "Uses same series as SerialNumber and is set on orders which is refunded.", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Invoices.Commands.UpdateStatus.UpdateStatusCommand": { "type": "object", "properties": { "orderIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "invoiceHandlingStatus": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Sales.Orders.InvoiceHandlingStatuses" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Invoices.Queries.List.InvoiceModel": { "type": "object", "properties": { "id": { "type": "string", "description": "Invoice id is the same as order id.", "format": "uuid" }, "referenceNumber": { "type": "integer", "description": "Reference number for the invoice / order.", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "string", "format": "uuid" }, "companyName": { "type": "string", "nullable": true }, "total": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Total amount of the invoice.", "nullable": true }, "handlingStatus": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Sales.Orders.InvoiceHandlingStatuses" } ], "description": "Bitwise status of the invoice.\n5 for example means that the invoice and refund is both unhandled.\n10 means that both are handled." }, "integrationStatus": { "type": "string", "description": "A text representation of the handling status, will be one of the following values:\n\"Invoice Unhandled\"\n\"Refund Unhandled\"\n\"Invoice and Refund UnHandled\"\nor null.", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Invoices.Queries.List.ListInvoiceQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Invoices.Queries.List.InvoiceModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.ModificationModel": { "type": "object", "properties": { "modification": { "type": "string", "nullable": true }, "ingredientId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "replaceId": { "type": "string", "format": "uuid", "nullable": true }, "replacementName": { "type": "string", "nullable": true }, "addOnGroupId": { "type": "string", "format": "uuid", "nullable": true }, "addOnGroupName": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "freeAmount": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "totalCost": { "type": "number", "format": "double" }, "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.OrderedProductModel": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productName": { "type": "string", "nullable": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantName": { "type": "string", "nullable": true }, "hasVariants": { "type": "boolean" }, "productGroupId": { "type": "string", "format": "uuid" }, "productGroupName": { "type": "string", "nullable": true }, "useBasePrice": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.CustomerModel": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.AddressModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.FeeModel": { "type": "object", "properties": { "feeId": { "type": "string", "format": "uuid" }, "feeName": { "type": "string", "nullable": true }, "amountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "amountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.TaxModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.MetadataModel": { "type": "object", "properties": { "metaData": { "description": "Rename for next version to Metadata", "nullable": true, "deprecated": true }, "metaDataType": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.OrderedProductModel" } ], "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitQuantity": { "type": "number", "format": "double" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.UnitModel" } ], "nullable": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "totalPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "totalMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.TaxModel" }, "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ModificationModel" }, "nullable": true }, "addOnProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemSubAddOnProductModel" }, "nullable": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountValueModel" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.RefundStatuses" } ], "nullable": true }, "soldAt": { "type": "string", "format": "date-time" }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemRefundModel" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemRefundModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.RefundStatuses" } ] }, "refundReference": { "type": "string", "format": "uuid" }, "orderItemId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemSubAddOnProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.OrderedProductModel" } ], "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitQuantity": { "type": "number", "format": "double" }, "unit": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.UnitModel" } ], "nullable": true }, "productPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "productPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "productMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "totalPriceExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "totalMaterialCostExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.TaxModel" }, "nullable": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountValueModel" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.RefundStatuses" } ], "nullable": true, "deprecated": true }, "addOnGroupId": { "type": "string", "format": "uuid" }, "addOnGroupName": { "type": "string", "nullable": true }, "addOnFreeAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.OrderModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.RefundStatuses" } ], "readOnly": true }, "refundedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.CustomerModel" } ], "nullable": true, "readOnly": true }, "delivery": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DeliveryInfoModel" } ], "nullable": true, "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Order total (include tax)\nThis amount includes modifications.\nThis amount includes fees.\nThis amount is calculated from SubtotalInclTax + FeeAmountInclTax\nThis amount is what must be paid or refunded to complete the order.", "nullable": true, "readOnly": true }, "taxAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Order total tax.", "nullable": true, "readOnly": true }, "subtotalInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Order sub total (include tax).\nThis amount is calculated from OrderItem.TotalPriceInclTax", "nullable": true, "readOnly": true }, "subtotalExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Order sub total (exclude tax).\nThis amount is calculated from OrderItem.TotalPriceExclTax", "nullable": true, "readOnly": true }, "subTotalDiscountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Gets the order subtotal discount (include tax)\nThis amount is calculated from OrderItem.DiscountAmountInclTax", "nullable": true, "readOnly": true }, "subTotalDiscountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Gets the order subtotal discount (exclude tax)\nThis amount is calculated from OrderItem.DiscountAmountExclTax", "nullable": true, "readOnly": true }, "feeAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Gets the total fee amount (include tax)\nThis amount is calculated from OrderFee.AmountInclTax", "nullable": true, "readOnly": true }, "feeAmountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "description": "Gets the total fee amount (exclude tax)\nThis amount is calculated from OrderFee.AmountExclTax", "nullable": true, "readOnly": true }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountModel" } ], "nullable": true, "readOnly": true }, "discountValue": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.DiscountValueModel" } ], "description": "The applied discount value.", "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.SalesLocationInfoModel" } ], "description": "Information about where this order was sold (table, bar etc.).", "nullable": true, "readOnly": true }, "source": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "saleSourceId": { "type": "string", "format": "uuid", "readOnly": true }, "outlet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true, "readOnly": true }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.PaymentModel" }, "nullable": true, "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderItemModel" }, "nullable": true, "readOnly": true }, "fees": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.FeeModel" }, "nullable": true, "readOnly": true }, "voucherBasisId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "incrementalNumbers": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.IncrementalNumbersModel" } ], "nullable": true, "readOnly": true }, "fromType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderCreatedFromTypes" } ], "readOnly": true }, "fromTypeCreated": { "type": "string", "format": "date-time", "readOnly": true }, "createdCheckTenantUserId": { "type": "string", "description": "The tenant user id of who created the check this order was created from.", "format": "uuid", "nullable": true, "readOnly": true }, "closedCheckTenantUserId": { "type": "string", "description": "Tenant user id of who closed the check this order was created from.", "format": "uuid", "nullable": true, "readOnly": true }, "createdCheckClientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "closedCheckClientId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "ticketedAt": { "type": "string", "description": "The time this order was ticketed.", "format": "date-time", "nullable": true, "readOnly": true }, "soldAt": { "type": "string", "description": "The time when this order was sold.\nWhen something is sold is different if the order comes from check or checkout.\nCheck: The last time an item was ticketed or if no tickets then it will be when the order was created.\nCheckout: The time the order was created.", "format": "date-time", "readOnly": true }, "checkoutAuthorizedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "checkoutServiceTime": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel" } ], "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.", "nullable": true, "readOnly": true }, "ticketClosedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "companyInfo": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.CompanyInfoModel" } ], "nullable": true, "readOnly": true }, "metaData": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.MetadataModel" }, "nullable": true, "readOnly": true }, "guestGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "parentOrderId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "customName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.PaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "orderId": { "type": "string", "format": "uuid" }, "amount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "cashBackAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "roundingAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "tipAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "paymentMethod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PaymentMethodModel" } ], "nullable": true }, "ourReference": { "type": "string", "format": "uuid" }, "externalReference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "tenantUserId": { "type": "string", "format": "uuid", "nullable": true }, "externalTimeStamp": { "type": "string", "format": "date-time", "nullable": true }, "integrationType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentIntegrationTypes" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderPaymentStatuses" } ] }, "centralControlUnitSerial": { "type": "string", "nullable": true }, "invoiceReferenceNote": { "type": "string", "nullable": true }, "invoiceHandlingStatus": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Sales.Orders.InvoiceHandlingStatuses" } ], "nullable": true }, "refunds": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.PaymentRefundModel" }, "nullable": true }, "mewsInfo": { "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.PaymentRefundModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refundedAt": { "type": "string", "format": "date-time", "nullable": true }, "refundAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "roundingAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "paymentId": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderPaymentStatuses" } ] }, "refundReference": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.Queries.Details.DetailOrderQueryResponse": { "type": "object", "properties": { "order": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Orders.Queries.DetaliedList.DetailedListOrderQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Orders.OrderModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.ReceiptModel": { "type": "object", "properties": { "receiverType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ReceiptReceiverTypes" } ] }, "needsSignature": { "type": "boolean" }, "receiptTexts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ReceiptTextModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.ReceiptTextModel": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.SalesLocationInfoModel": { "type": "object", "properties": { "salesLocationId": { "type": "string", "format": "uuid", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel": { "type": "object", "properties": { "kind": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ServiceTimeKinds" } ] }, "time": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side." }, "Core.Api.Models.Public.V1.V0.Sales.TaxModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.CustomerInfoModel": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.AddressModel" } ], "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.OrderedProductModel": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "productName": { "type": "string", "nullable": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ] }, "variantId": { "type": "string", "format": "uuid" }, "variantName": { "type": "string", "nullable": true }, "variantType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.VariantTypes" } ] }, "hasVariants": { "type": "boolean" }, "productGroupId": { "type": "string", "format": "uuid" }, "productGroupName": { "type": "string", "nullable": true }, "glassesPerBottle": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.Detail.DetailTicketQueryResponse": { "type": "object", "properties": { "ticket": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.DetailedListTicketQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.TicketModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.TicketItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.OrderedProductModel" } ], "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitQuantity": { "type": "number", "format": "double" }, "unit": { "type": "string", "nullable": true }, "unitType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.UnitTypes" } ] }, "kitchenMessage": { "type": "string", "nullable": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "ticketDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ModificationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.TicketModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "ticketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderTypes" } ], "readOnly": true }, "serviceTime": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel" } ], "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.", "nullable": true, "readOnly": true }, "preparationTime": { "type": "string", "format": "date-span", "nullable": true, "readOnly": true }, "customerName": { "type": "string", "nullable": true, "readOnly": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.SalesLocationModel" } ], "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TicketStatuses" } ], "readOnly": true }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subtotalInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subTotalDiscountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "feeAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "subTickets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.SubTicketModel" }, "nullable": true, "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.Queries.DetailedList.TicketItemModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.SalesLocationModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SalesLocationTypes" } ] }, "table": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.TableModel" } ], "nullable": true }, "pos": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true }, "express": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.SubTicketModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ticketDestinationId": { "type": "string", "format": "uuid" }, "isCompleted": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketFeeItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "feeId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "amountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "amountExclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.OrderedProductModel" } ], "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitQuantity": { "type": "number", "format": "double" }, "unit": { "type": "string", "nullable": true }, "unitType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.UnitTypes" } ] }, "kitchenMessage": { "type": "string", "nullable": true }, "totalPriceInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "discountAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "ticketDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "modifications": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ModificationModel" }, "nullable": true }, "courseName": { "type": "string", "nullable": true }, "coursePosition": { "type": "integer", "format": "int32" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TicketItemStatuses" } ] }, "ticketItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketItemModel" }, "nullable": true }, "ticketItemType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TicketItemTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "incrementalNumbers": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.IncrementalNumbersModel" } ], "nullable": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "serviceTime": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.ServiceTimeModel" } ], "description": "Service time for the sale.\nNo time is needed for Kind.AsSoonAsPossible it will be set as current UTC time on server side.", "nullable": true }, "preparationTime": { "type": "string", "nullable": true }, "customer": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.CustomerInfoModel" } ], "nullable": true }, "salesLocation": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.SalesLocationModel" } ], "nullable": true }, "delivery": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.DeliveryModel" } ], "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TicketStatuses" } ] }, "instructions": { "type": "string", "nullable": true }, "acceptedAt": { "type": "string", "format": "date-time" }, "preparingAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "readyAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "closedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "autoMode": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Sales.Tickets.AutoModes" } ] }, "source": { "type": "string", "nullable": true }, "saleSourceId": { "type": "string", "format": "uuid" }, "customTicketNumber": { "type": "integer", "format": "int64", "nullable": true }, "totalAmount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "subtotalInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "subTotalDiscountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "feeAmountInclTax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "fees": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketFeeItemModel" }, "nullable": true }, "subTickets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.SubTicketModel" }, "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Sales.Tickets.TicketItemModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Sales.UnitModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.UnitTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.SettlementReports.Queries.List.ListSettlementReportQueryReponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.SettlementReports.Queries.List.SettlementReportModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.SettlementReports.Queries.List.SettlementReportModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "reportType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.SettlementReportTypes" } ], "readOnly": true }, "integrationId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "reportDate": { "type": "string", "format": "date-time", "readOnly": true }, "batchNo": { "type": "string", "nullable": true }, "dateRange": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.DateRangeModel" } ], "nullable": true, "readOnly": true }, "voucherNumbers": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "sum": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "sumIncludingFee": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "transactionFee": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "otherFees": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "invoiceDeductions": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "balancetransfers": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true }, "total": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Tags.Queries.List.ListTagsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Tags.Queries.List.TagModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Tags.Queries.List.TagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Tags.TagTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Taxes.OutletTaxSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "outletName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Taxes.Queries.Detail.DetailTaxQueryResponse": { "type": "object", "properties": { "tax": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Taxes.TaxModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Taxes.Queries.List.ListTaxesQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Taxes.Queries.List.TaxModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Taxes.Queries.List.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" }, "isMandatory": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Taxes.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "value": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.TaxValueModel" } ], "nullable": true }, "isDeleted": { "type": "boolean" }, "isMandatory": { "type": "boolean" }, "outletTaxSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Taxes.OutletTaxSettingsModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.TenantUsers.Queries.Detail.DetailTenantUserQueryResponse": { "type": "object", "properties": { "tenantUser": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.TenantUsers.Queries.TenantUserModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.TenantUsers.Queries.TenantUserModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "socialSecurityNumber": { "type": "string", "nullable": true }, "modified": { "type": "string", "format": "date-time" }, "isDisabled": { "type": "boolean" }, "disabled": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" }, "deleted": { "type": "string", "format": "date-time", "nullable": true }, "isTenantAdmin": { "type": "boolean" }, "identityUserId": { "type": "string", "format": "uuid" }, "receiveBroadcastEmails": { "type": "boolean" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Tenants.Outlets.Queries.List.ListTenantOutletsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Tenants.Queries.Detail.DetailTenantQueryResponse": { "type": "object", "properties": { "tenant": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.Tenants.Queries.Detail.TenantModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.Tenants.Queries.Detail.TenantModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "shareableTypes": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ShareableTypes" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse": { "type": "object", "properties": { "wayOfPayment": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.WayOfPaymentModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.WayOfPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "printSignatureReceipt": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "outletWayOfPaymentSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "outletName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "feeAccountId": { "type": "string", "format": "uuid", "nullable": true }, "feeAccountNumber": { "type": "string", "nullable": true }, "payoutAccountId": { "type": "string", "format": "uuid", "nullable": true }, "payoutAccountNumber": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.List.WayOfPaymentModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V0.WayOfPayments.Queries.List.WayOfPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Discounts.DiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "allowMultipleUses": { "type": "boolean" }, "discountType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "validPeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PeriodModel" } ], "nullable": true }, "validDayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ] }, "validTimePeriod": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.TimePeriodModel" } ], "nullable": true }, "allValue": { "type": "number", "format": "double", "nullable": true }, "discountAvailabilities": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Discounts.DiscountAvailabilities" } ] }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Discounts.ProductDiscountModel" }, "nullable": true }, "productGroups": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Discounts.ProductGroupDiscountModel" }, "nullable": true }, "outlets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Discounts.ProductDiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Discounts.ProductGroupDiscountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Discounts.Queries.Detail.DetailDiscountQueryResponse": { "type": "object", "properties": { "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Discounts.DiscountModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.DetailOutletQueryResponse": { "type": "object", "properties": { "outlet": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.OutletModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.OutletModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "tenantId": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "businessNumber": { "type": "string", "nullable": true, "readOnly": true }, "timeZoneOffset": { "type": "string", "format": "date-span", "readOnly": true }, "openingHours": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.OutletOpeningHoursModel" }, "nullable": true, "readOnly": true }, "deliveryArea": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.OutletDeliveryAreaModel" } ], "nullable": true, "readOnly": true }, "blockedVisibilities": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.BlockedVisibilities" } ], "readOnly": true }, "verificationSeries": { "type": "string", "nullable": true, "readOnly": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true, "readOnly": true }, "tip": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.TipSettingsModel" } ], "nullable": true, "readOnly": true }, "autoOrderVoucherBasisTime": { "type": "string", "format": "time", "readOnly": true }, "generateAutoOrderVoucherBasis": { "type": "boolean", "readOnly": true }, "smsSenderId": { "type": "string", "nullable": true, "readOnly": true }, "autoAcceptOrderMode": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AutoAcceptOrderModes" } ], "readOnly": true }, "supportedOrderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "orderFormatSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.OrderFormatSettingsModel" }, "nullable": true, "readOnly": true }, "receiptSettings": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Outlets.Queries.OutletReceiptSettingsModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.Detail.OutletOpeningHoursModel": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.HoursTypes" } ], "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "state": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OpeningHoursStates" } ], "readOnly": true }, "dayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ], "readOnly": true }, "periodFrom": { "type": "string", "format": "date-time", "readOnly": true }, "periodTo": { "type": "string", "format": "date-time", "readOnly": true }, "from": { "type": "string", "format": "time", "readOnly": true }, "duration": { "type": "string", "format": "date-span", "readOnly": true }, "reason": { "type": "string", "nullable": true, "readOnly": true }, "isDefault": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.OrderFormatSettingsModel": { "type": "object", "properties": { "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] }, "preparationTime": { "type": "string", "format": "date-span", "readOnly": true }, "options": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.OrderFormatOptions" } ], "readOnly": true }, "minimumOrder": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "aoTippingPercentages": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Outlets.AOTippingPercentages" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.OutletDeliveryAreaModel": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.LocationModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.OutletReceiptSettingsModel": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "logoId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Outlets.Queries.TipSettingsModel": { "type": "object", "properties": { "showTipAs": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ShowTipAs" } ] }, "reduceAmountOn": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ReduceAmountOn" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.AccountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "number": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Create.CreateProductGroupCommand": { "required": [ "name", "outletProductGroupSettings" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.TaxModel" }, "nullable": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.OutletProductGroupSettingsModel" } }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Create.CreateProductGroupCommandResponse": { "type": "object", "properties": { "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.ProductGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.OutletProductGroupSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "accountNumber": { "pattern": "^(?:[0-9]{1,4})$", "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "maxLength": 3, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.TaxModel": { "required": [ "orderFormats" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ] } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Update.UpdateProductGroupCommand": { "required": [ "name", "outletProductGroupSettings" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.TaxModel" }, "nullable": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.Commands.OutletProductGroupSettingsModel" } }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.Commands.Update.UpdateProductGroupCommandResponse": { "type": "object", "properties": { "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.ProductGroupModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.OutletProductGroupSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "outletName": { "type": "string", "nullable": true, "readOnly": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "accountNumber": { "type": "string", "nullable": true, "readOnly": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true, "readOnly": true }, "custom1": { "type": "string", "nullable": true, "readOnly": true }, "custom2": { "type": "string", "nullable": true, "readOnly": true }, "custom3": { "type": "string", "nullable": true, "readOnly": true }, "custom4": { "type": "string", "nullable": true, "readOnly": true }, "custom5": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.ProductGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductGroupTypes" } ], "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.TaxModel" }, "nullable": true, "readOnly": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.AccountModel" }, "nullable": true, "readOnly": true }, "outletProductGroupSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.ProductGroups.OutletProductGroupSettingsModel" }, "nullable": true, "readOnly": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.ProductGroups.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "rate": { "type": "number", "format": "double", "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.AddOnGroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "addOnGroupId": { "type": "string", "format": "uuid" }, "addOnGroupName": { "type": "string", "nullable": true }, "position": { "type": "integer", "format": "int32" }, "minimumAmount": { "type": "number", "format": "double" }, "maximumAmount": { "type": "number", "format": "double" }, "allowMultiple": { "type": "boolean" }, "freeAmount": { "type": "number", "format": "double" }, "afterFreePrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true }, "customerFacingName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.CourseModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "code": { "type": "string", "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "courseGroupId": { "type": "string", "format": "uuid", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.Detail.DetailProductQueryResponse": { "type": "object", "properties": { "product": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ProductModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.IngredientModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "ingredientId": { "type": "string", "format": "uuid", "readOnly": true }, "ingredientName": { "type": "string", "nullable": true, "readOnly": true }, "isMandatory": { "type": "boolean", "readOnly": true }, "hasReplacements": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "replacements": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ReplacementIngredientModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ItemPriceModel": { "type": "object", "properties": { "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.MenuTreeItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "menuTreeBranchId": { "type": "string", "format": "uuid", "readOnly": true }, "menuTreeBranchName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.OutletStockModel": { "type": "object", "properties": { "stockProductId": { "type": "string", "format": "uuid", "readOnly": true }, "outletId": { "type": "string", "format": "uuid", "readOnly": true }, "productVariantId": { "type": "string", "format": "uuid", "readOnly": true }, "stockCount": { "type": "number", "format": "double", "readOnly": true }, "reorderCount": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.PricePresetModel": { "type": "object", "properties": { "pricePresetId": { "type": "string", "format": "uuid", "readOnly": true }, "pricePresetName": { "type": "string", "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ProductAvailabilityHourModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "systemVisibility": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Products.SystemVisibilities" } ], "nullable": true, "readOnly": true }, "dayOfWeek": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DayOfWeekTypes" } ], "readOnly": true }, "from": { "type": "string", "format": "time", "readOnly": true }, "duration": { "type": "string", "format": "date-span", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ProductAvailabilityModel": { "type": "object", "properties": { "systemVisibility": { "allOf": [ { "$ref": "#/components/schemas/Shared.Models.Products.SystemVisibilities" } ], "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "productType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.ProductTypes" } ], "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "customerFacingName": { "type": "string", "nullable": true, "readOnly": true }, "ticketName": { "type": "string", "nullable": true, "readOnly": true }, "productNumber": { "type": "string", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "allergyInformation": { "type": "string", "nullable": true, "readOnly": true }, "image": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "useAvailabilityHours": { "type": "boolean", "readOnly": true }, "hasVariants": { "type": "boolean", "readOnly": true }, "mandatoryToPickVariant": { "type": "boolean", "readOnly": true }, "autoAccept": { "type": "boolean", "readOnly": true }, "flowViewEnabled": { "type": "boolean", "readOnly": true }, "glassesPerBottle": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "availableVolumes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true, "readOnly": true }, "isSystemProduct": { "type": "boolean", "readOnly": true }, "metaData": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" }, "nullable": true, "readOnly": true }, "productGroup": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" } ], "nullable": true, "readOnly": true }, "course": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.CourseModel" } ], "nullable": true, "readOnly": true }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.VariantModel" }, "nullable": true, "readOnly": true }, "outletShares": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.OutletShareQueryModel" }, "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.TaxModel" }, "nullable": true, "readOnly": true }, "menuTreeItems": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.MenuTreeItemModel" }, "nullable": true, "readOnly": true }, "productAvailabilities": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ProductAvailabilityModel" }, "nullable": true, "readOnly": true }, "availabilityHours": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ProductAvailabilityHourModel" }, "nullable": true, "readOnly": true }, "ticketDestinations": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true, "readOnly": true }, "addOnGroups": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.AddOnGroupModel" }, "nullable": true, "readOnly": true }, "upsellGroups": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.IdNameModel" }, "nullable": true, "readOnly": true }, "ingredients": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.IngredientModel" }, "nullable": true, "readOnly": true }, "productTags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.TagModel" }, "nullable": true, "readOnly": true }, "productGroupTags": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.TagModel" }, "nullable": true, "readOnly": true }, "subProducts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.SubProductModel" }, "nullable": true, "readOnly": true }, "hasIngredients": { "type": "boolean", "readOnly": true }, "hasAddOnGroups": { "type": "boolean", "readOnly": true }, "hasUpsellGroups": { "type": "boolean", "readOnly": true }, "hasProductTags": { "type": "boolean", "readOnly": true }, "hasProductGroupTags": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ProductOverridePriceModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "priceGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "orderFormat": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "outletName": { "type": "string", "nullable": true, "readOnly": true }, "priceGroupName": { "type": "string", "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ReplacementIngredientModel": { "type": "object", "properties": { "ingredientId": { "type": "string", "format": "uuid", "readOnly": true }, "ingredientName": { "type": "string", "nullable": true, "readOnly": true }, "ingredientPrice": { "type": "number", "format": "double", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "overridePrice": { "type": "boolean", "readOnly": true }, "price": { "type": "number", "format": "double", "readOnly": true }, "currency": { "type": "string", "nullable": true, "readOnly": true }, "prices": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ReplacementOverridePriceModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.ReplacementOverridePriceModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "priceGroupId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "orderFormats": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.OrderFormats" } ], "readOnly": true }, "outletName": { "type": "string", "nullable": true, "readOnly": true }, "priceGroupName": { "type": "string", "nullable": true, "readOnly": true }, "orderFormatName": { "type": "string", "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.MoneyModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.SubProductModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "productId": { "type": "string", "format": "uuid", "readOnly": true }, "variantId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "productName": { "type": "string", "nullable": true, "readOnly": true }, "useOverridePrice": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "quantity": { "type": "number", "format": "double", "readOnly": true }, "outletShares": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true, "readOnly": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.TaxModel" }, "nullable": true, "readOnly": true }, "subProductVariants": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.SubProductVariantModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.SubProductVariantModel": { "type": "object", "properties": { "variantId": { "type": "string", "format": "uuid", "readOnly": true }, "variantName": { "type": "string", "nullable": true, "readOnly": true }, "price": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ItemPriceModel" } ], "nullable": true, "readOnly": true }, "overridePrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ItemPriceModel" } ], "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.TagModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Core.Domain.Models.Tags.TagTypes" } ], "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.TaxModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "taxType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ], "readOnly": true }, "rate": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.Products.Queries.VariantModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string", "nullable": true, "readOnly": true }, "customerFacingName": { "type": "string", "nullable": true, "readOnly": true }, "ticketName": { "type": "string", "nullable": true, "readOnly": true }, "variantType": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.VariantTypes" } ], "readOnly": true }, "isMainProductVariant": { "type": "boolean", "readOnly": true }, "useBasePrice": { "type": "boolean", "readOnly": true }, "isOpenPrice": { "type": "boolean", "readOnly": true }, "variantNumber": { "type": "string", "nullable": true, "readOnly": true }, "variantPrice": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "overridePrices": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.ProductOverridePriceModel" }, "nullable": true, "readOnly": true }, "materialCost": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PricePerUnitMoneyModel" } ], "nullable": true, "readOnly": true }, "position": { "type": "integer", "format": "int32", "readOnly": true }, "outletStocks": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.OutletStockModel" }, "nullable": true, "readOnly": true }, "pricePresets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.Products.Queries.PricePresetModel" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse": { "type": "object", "properties": { "wayOfPayment": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.WayOfPaymentModel" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.WayOfPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "printSignatureReceipt": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "outletWayOfPaymentSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "outletName": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "feeAccountId": { "type": "string", "format": "uuid", "nullable": true }, "feeAccountNumber": { "type": "string", "nullable": true }, "payoutAccountId": { "type": "string", "format": "uuid", "nullable": true }, "payoutAccountNumber": { "type": "string", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.List.WayOfPaymentListModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V1.WayOfPayments.Queries.List.WayOfPaymentListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.AccountModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.DetailWayOfPaymentQueryResponse": { "type": "object", "properties": { "wayOfPayment": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.WayOfPaymentModel" } ], "nullable": true }, "outlets": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.OutletListModel" }, "nullable": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.AccountModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.OutletListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.SubWayOfPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "outletSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.WayOfPaymentModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "printSignatureReceipt": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "outletSettings": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel" }, "nullable": true }, "subWayOfPayments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.SubWayOfPaymentModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.Detail.WayOfPaymentOutletSettingsModel": { "type": "object", "properties": { "outletId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "voucherTracking": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.VoucherTrackingModel" } ], "nullable": true }, "feeAccountId": { "type": "string", "format": "uuid", "nullable": true }, "payoutAccountId": { "type": "string", "format": "uuid", "nullable": true }, "custom1": { "type": "string", "nullable": true }, "custom2": { "type": "string", "nullable": true }, "custom3": { "type": "string", "nullable": true }, "custom4": { "type": "string", "nullable": true }, "custom5": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.ListWayOfPaymentsQueryResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.WayOfPaymentListModel" }, "nullable": true }, "meta": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.PagedResponseMetadata" } ], "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.SubWayOfPaymentListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.WayOfPaymentListModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.PaymentMethodTypes" } ] }, "name": { "type": "string", "nullable": true }, "subWayOfPayments": { "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.Public.V1.V2.WayOfPayments.Queries.List.SubWayOfPaymentListModel" }, "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.Public.V1.VoucherTrackingModel": { "type": "object", "properties": { "costCenter": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.CheckItemModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double", "deprecated": true } }, "additionalProperties": false }, "Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.DiscountCheckItemCommand": { "required": [ "checkItems" ], "type": "object", "properties": { "checkItems": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.CheckItemModel" } }, "discount": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.DiscountValueModel" } ], "nullable": true }, "discountId": { "type": "string", "format": "uuid", "nullable": true, "deprecated": true }, "pinOverride": { "maxLength": 4, "minLength": 4, "type": "string", "nullable": true } }, "additionalProperties": false }, "Core.Api.Models.V1.V0.Sales.Checks.Commands.Discount.DiscountValueModel": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ] } }, "additionalProperties": false }, "Core.Application.Handlers.Outlets.Sections.Tables.Queries.List.TableModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "number": { "type": "integer", "format": "int32", "readOnly": true }, "availableForTableOrder": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "Core.Domain.Models.MenuTrees.MenuTreeItemTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.MenuTrees.MenuTreeTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Metadatas.MetadataTypes": { "enum": [ 0 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Outlets.AOTippingPercentages": { "type": "object", "properties": { "percentage1Enabled": { "type": "boolean" }, "percentage1Value": { "type": "integer", "format": "int32" }, "percentage2Enabled": { "type": "boolean" }, "percentage2Value": { "type": "integer", "format": "int32" }, "percentage3Enabled": { "type": "boolean" }, "percentage3Value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Core.Domain.Models.Outlets.AutoAcceptOrderModes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Outlets.BlockedVisibilities": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Outlets.OrderFormatOptions": { "enum": [ 1, 2, 4, 8, 16, 32, 64, 128 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionStatuses": { "enum": [ 0, 1, 2, 3, -3, -2, -1 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Sales.Checks.CheckPayments.CheckPaymentTransactionTypes": { "enum": [ 0, 1, 2, 3, 4, -2, -1 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Sales.Checks.CheckStatuses": { "enum": [ 0, 1, 2, 3, 4, -3, -2, -1 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Sales.Checks.Dtos.CheckTaxDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "itemId": { "type": "string", "format": "uuid" }, "tax": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.UsedTax" } ], "nullable": true } }, "additionalProperties": false }, "Core.Domain.Models.Sales.Tickets.AutoModes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Core.Domain.Models.Tags.TagTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Core.Domain.ValueObjects.UserWithEmail": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.PersonalName" } ], "nullable": true }, "email": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.EmailAddress" } ], "nullable": true } }, "additionalProperties": false }, "Microsoft.AspNetCore.Mvc.ProblemDetails": { "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 } }, "additionalProperties": { } }, "Newtonsoft.Json.Linq.JToken": { "type": "array", "items": { "$ref": "#/components/schemas/Newtonsoft.Json.Linq.JToken" } }, "Shared.Enums.AddressTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.CardNumberTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.CardPaymentErrorTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckItemStatuses": { "enum": [ 0, 1, 2, 4, 8, 16, 32 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckPaymentStatuses": { "enum": [ 0, 1, 2, 3, 4, 5, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckoutPaymentStatuses": { "enum": [ 0, 1, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckoutStatuses": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -2, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckoutTransactionStatuses": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Shared.Enums.CheckoutTransactionTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "format": "int32" }, "Shared.Enums.ClientTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "format": "int32" }, "Shared.Enums.DayOfWeekTypes": { "enum": [ 0, 1, 2, 4, 8, 16, 31, 32, 64, 96, 127 ], "type": "integer", "format": "int32" }, "Shared.Enums.DiscountTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.HoursTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.IntegrationTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -2, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.OpeningHoursStates": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.OrderCreatedFromTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.OrderFormats": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191 ], "type": "integer", "format": "int32" }, "Shared.Enums.OrderPaymentStatuses": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "format": "int32" }, "Shared.Enums.OrderTypes": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Shared.Enums.PaymentIntegrationTypes": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.PaymentMethodTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 ], "type": "integer", "format": "int32" }, "Shared.Enums.PaymentProviderType": { "enum": [ 0, 1, 2, 3, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.ProductGroupTypes": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Shared.Enums.ProductShareTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.ProductTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "format": "int32" }, "Shared.Enums.ReceiptReceiverTypes": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.ReduceAmountOn": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.RefundStatuses": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Shared.Enums.SaleSourceTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.SalesLocationTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Shared.Enums.ServiceTimeKinds": { "enum": [ 0, 1, -1 ], "type": "integer", "format": "int32" }, "Shared.Enums.SettlementReportTypes": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.ShareableTypes": { "enum": [ 0, 1, 2, 4, 8 ], "type": "integer", "format": "int32" }, "Shared.Enums.ShowTipAs": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Enums.SubCheckItemStatuses": { "enum": [ 0, 1, 2, 4, 8 ], "type": "integer", "format": "int32" }, "Shared.Enums.TaxTypes": { "enum": [ 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.TicketItemStatuses": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Shared.Enums.TicketItemTypes": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "Shared.Enums.TicketStatuses": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "format": "int32" }, "Shared.Enums.UnitTypes": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "format": "int32" }, "Shared.Enums.VariantTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "Shared.Enums.WalletNumberTypes": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "Shared.Models.Discounts.DiscountAvailabilities": { "enum": [ 0, 1, 2, 4, 8, 16, 32 ], "type": "integer", "format": "int32" }, "Shared.Models.Products.SystemVisibilities": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "Shared.Models.Sales.Orders.InvoiceHandlingStatuses": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "format": "int32" }, "Shared.ValueObjects.Address": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Location" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.CompanyInfo": { "type": "object", "properties": { "companyId": { "type": "string", "format": "uuid", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyBusinessNumber": { "type": "string", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.GeneralAddress" } ], "nullable": true }, "invoiceEmail": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.EmailAddress" } ], "nullable": true }, "memberId": { "type": "string", "format": "uuid", "nullable": true }, "memberName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.CurrencyCode": { "type": "object", "properties": { "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.CustomerInfo": { "type": "object", "properties": { "email": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.EmailAddress" } ], "nullable": true }, "fullName": { "type": "string", "nullable": true }, "customerId": { "type": "string", "format": "uuid", "nullable": true }, "identityUserId": { "type": "string", "format": "uuid", "nullable": true }, "address": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Address" } ], "nullable": true }, "phone": { "type": "string", "nullable": true }, "saleSourceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.DiscountInfo": { "type": "object", "properties": { "discountId": { "type": "string", "format": "uuid", "nullable": true }, "discountName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.DiscountValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.DiscountTypes" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.EmailAddress": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.GeneralAddress": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "street2": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.IdName": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.LocalizedString": { "type": "object", "properties": { "translations": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.Location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Shared.ValueObjects.Money": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.Name": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.PaymentTypes": { "enum": [ 1, 2, 3 ], "type": "integer", "format": "int32" }, "Shared.ValueObjects.PersonalName": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.PricePerUnitMoney": { "type": "object", "properties": { "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true }, "additionalPrice": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.Quantity": { "type": "object", "properties": { "value": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Shared.ValueObjects.Sales.ProductAddOnGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "localizedCustomerFacingNames": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.LocalizedString" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.Sales.ProductIngredient": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Name" } ], "nullable": true }, "localizedNames": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.LocalizedString" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.Size": { "type": "object", "properties": { "height": { "type": "integer", "format": "int32" }, "width": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Shared.ValueObjects.SortPosition": { "type": "object", "properties": { "position": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Shared.ValueObjects.StorageInformation": { "type": "object", "properties": { "temperature": { "type": "integer", "format": "int32" }, "size": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Size" } ], "nullable": true } }, "additionalProperties": false }, "Shared.ValueObjects.TaxValue": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.TaxTypes" } ] }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Shared.ValueObjects.Unit": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/Shared.Enums.UnitTypes" } ] } }, "additionalProperties": false }, "Shared.ValueObjects.UsedTax": { "type": "object", "properties": { "taxId": { "type": "string", "format": "uuid" }, "taxValue": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.TaxValue" } ], "nullable": true } }, "additionalProperties": false }, "System.Tuple`2[[Core.Api.Controllers.Public.V2.Sales.Checks.V0.WalletInfoModel, Core.Api, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null],[Shared.ValueObjects.Money, Shared, Version=1.0.1781.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "item1": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.Public.V2.Sales.Checks.V0.WalletInfoModel" } ], "nullable": true }, "item2": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true } }, "additionalProperties": false }, "System.Tuple`2[[Core.Api.Controllers.V2.Sales.Checks.V0.WalletInfoModel, Core.Api, Version=10.1.8.687, Culture=neutral, PublicKeyToken=null],[Shared.ValueObjects.Money, Shared, Version=1.0.1781.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "item1": { "allOf": [ { "$ref": "#/components/schemas/Core.Api.Controllers.V2.Sales.Checks.V0.WalletInfoModel" } ], "nullable": true }, "item2": { "allOf": [ { "$ref": "#/components/schemas/Shared.ValueObjects.Money" } ], "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using bearer scheme", "name": "Authorization", "in": "header" }, "Access-Token": { "type": "apiKey", "description": "Access token in header", "name": "Access-Token", "in": "header" } } }, "tags": [ { "name": "AddOnGroups" }, { "name": "Checkouts" }, { "name": "Checks" }, { "name": "Companies" }, { "name": "Discounts" }, { "name": "Fees" }, { "name": "Ingredients" }, { "name": "Integrations" }, { "name": "Invoices" }, { "name": "MenuTrees" }, { "name": "MetadataTemplates" }, { "name": "Orders", "description": "Orders are the sale history for the outlet, orders are created when a check or checkout is fully paid.\nThe order holds information about what products was sold and how it was paid." }, { "name": "OutletClientGroups" }, { "name": "OutletClients" }, { "name": "Outlets", "description": "Outlet is the physical place where the sales happen, it is the restaurant or bar." }, { "name": "ProductGroups" }, { "name": "Products", "description": " Products use a draft/publish flow.\r\nThis means any updates made on a product created / mopdifies a draft(copy) of the product which can be worked on with many update requestsuntil finally when you want to publish / apply the changes the 'Publish product' endpont must be called for any change to take affect.\r\nTo get the product images use cdn: https://{environment}.media.ancon.io/{tenantId}/product/{productId}/{imageId}\r\nProduction does not have an environment prefix then just use https://media.ancon.io/{tenantId}/product/{productId}/{imageId}" }, { "name": "SaleSources" }, { "name": "Sections" }, { "name": "SettlementReports" }, { "name": "Tables" }, { "name": "Tags" }, { "name": "Taxes" }, { "name": "Tenants", "description": "Tenant is a collection of outlets and has entities settings attached to it." }, { "name": "TenantUsers" }, { "name": "Tickets" }, { "name": "UpsellGroups" }, { "name": "WayOfPayments" }, { "name": "Checks - Events", "description": "Event payload schemas. These are not HTTP endpoints - they document the JSON structure sent via WebSocket when events occur." } ] }