⚙️Settings

This page provides a description of the available API routes for managing settings.

The API offers a range of modules and extensions that require configuration. In order to faciliate the process of module configuration, the API provides methods for accessing and managing stored configurations. These configurations are represented by a Settings class.

Every module has its unique identifier, which is used as key when accessing given configuration section.

API methods

Get settings

GET http://{server-address}/settings

Returns all stored settings. Result is of type Dictionary<string,Settings>. The dictionary keys represents settings section keys.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Successful response

{
    "Portos.Features.Qerko":
    {
        "IsEnabled": true,
        "ApiKey": "aaaa-bbbb-cccc-dddd-eeee-ffff",
        "Environment": "development",
        "StockName": "Qerko",
        "FiscalName": "eKasa",
        "TicketForm": "Print",
        "PaymentTypeNumber": 2,
        "AllowPartialPayment": true,
        "IsTipAllowed": true,
        "IsOrderToTicketEnabled": true,
        "IsOrderToTableEnabled": true,
        "IsTakeAwayOrderEnabled": true,
        "IsOrderConfirmationPrintingEnabled": true,
        "IsPaymentConfirmationPrintingEnabled": true,
        "IsNettoTipOnPaymentConfirmationEnabled": false,
        "UploadMenuOnStart": true,
        "OutOfStockMode": "belowMinimalStockQuantity",
        "TipVatCategory": 1,
        "DiscountVatCategory": 1
    },
    "Portos.Features.Camarero":
    {
        "IsEnabled": false,
        "InputDirectoryPath": "C:/POS/",
        "UnprocessableFilesDirectoryPath": "C:/POS/FAILED/",
        "FileReadMaxRetryCount": 3,
        "FileReadRetryDelayMs": 300,
        "FileExtension": ".pda",
        "QuantityScale": 2,
        "UnitPriceScale": 2,
        "DefaultStockName": "S02",
        "DefaultFiscalName": null,
        "DefaultVatCategory": 1,
        "DefaultUnit": "ks",
        "DefaultPurchaseType": "WalkIn",
        "RoundingTreshold": 0.05,
        "SkipOrdersProcessing": true,
        "ProcessOrders": false
    },
    "Portos.Features.OrderManagement":
    {
        "LastOrderNumber": 1
    }
}

Get settings section

GET http://{server-address}/settings/{key}

Result is of type Settings.

Path Parameters

Name	Type	Description
key*	string	The settings section identifier.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Resource found.

{
    "LastOrderNumber": 1
}

404: Not Found Settings section is not found.

Create or update settings section

PUT http://{server-address}/settings/{key}

Updates existing or creates new settings section. The result of this operation is of type Settings.

Required rights

No user rights are required.

Path Parameters

Name	Type	Description
key*	string	The settings section identifier.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

Request Body

Name	Type	Description
(body)*	Settings	Settings object to store.

200: OK Successfuly created or updated.

{
    "LastOrderNumber": 1
}

Partially update settings section

PATCH http://{server-address}/settings

This method updates only a subset of the settings section. Any properties that are not present in the request body will remain unchanged. The result of this operation is of type Settings.

Required rights

No user rights are required.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

Request Body

Name	Type	Description
(body)*	Settings	Partial settings object to store.

200: OK Successfuly updated.

{
    "LastOrderNumber": 1
}

Delete settings section

DELETE http://{server-address}/settings/{key}

Required rights

No user rights are required.

Path Parameters

Name	Type	Description
name*	string	The settings section identifier.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Successfuly deleted.

{
    "LastOrderNumber": 1
}