PORTOS Developers
  • πŸ‘‹Introduction
  • πŸ“–Glossary
  • HTTP Status codes
  • Error models
  • Error codes
  • Validation constraints
  • Resource names
  • πŸ”’User rights
  • Device environments
  • 🌍Localization
  • πŸ”NData query syntax
  • OpenAPI specification
  • Data models
  • Authentication
    • πŸ”Authentication schemes
      • JWT Bearer Authentication
      • HMAC Authentication
  • ⚑Notifications
    • SignalR
    • Webhooks
  • API reference
    • πŸ”‘API keys
    • πŸ›οΈArticle categories
    • πŸ’ΌCompanies
    • πŸ’±Currencies
    • πŸ‘«Customers
    • πŸ“ˆDaily sales reports
    • πŸ–₯️Devices
    • πŸ–¨οΈFiscals
    • ❀️Health check
    • πŸ“ƒLicense
    • 🎚️Modifiers
    • πŸ‘¨β€πŸ³Order endpoints
    • πŸ›ŽοΈOrders
    • πŸͺ™Payment types
    • β˜•Plus
    • πŸ”Roles
    • πŸ”Sessions
    • βš™οΈSettings
    • πŸ”ŽStock takings
    • πŸ”’Stock transfer numbering
    • 🚚Stock transfers
    • πŸ“¦Stocks
    • 🧾Tickets
      • Ticket Model States
      • Ticket Operations and User Rights
      • Ticket Model Mathematics
    • πŸ‘¨β€πŸ’ΌUsers
    • βš–οΈVats
    • πŸͺ‘Zones
  • 3rd Party Integrations
    • Introduction
    • Online orders API
    • Rewards API
    • PDA Files
  • Previous versions
    • Migration to V4.1
    • Migration to V4
    • Legacy documentation
Powered by GitBook
On this page
  • API methods
  • Get settings
  • Get settings section
  • Create or update settings section
  • Partially update settings section
  • Delete settings section

Was this helpful?

  1. API reference

Settings

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

PreviousSessionsNextStock takings

Last updated 1 year ago

Was this helpful?

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 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,>. The dictionary keys represents settings section keys.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "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}

Path Parameters

Name
Type
Description

key*

string

The settings section identifier.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "LastOrderNumber": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Create or update settings section

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

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.

{
    "LastOrderNumber": 1
}

Partially update settings section

PATCH http://{server-address}/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.

{
    "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.

{
    "LastOrderNumber": 1
}

Result is of type .

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

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
Settings
Settings
Settings
Settings