API docs by Redocly

Transaction-Api (1.0.1)

Download OpenAPI specification:

E-mail: api@oktopos.com

The OktoPOS Manager TransactionAPI provides a way to get transactions from the OktoPOS Manager for third party applications.

Authentication

All functions in this API require a valid authentication token. You can find this token in your instance of OktoPOS Manager in OktoPOS -> System.

Changes

1.0.1

Clarified path parameter descriptions for the transactions endpoint to explicitly state that all path parameters are optional.

transactions

Get a transaction by identifier

Authorizations:
api_key
path Parameters
identifier
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get transactions by filter parameters.

All results are sorted by date of sale.

All filter parameters are optional and can be omitted. If a parameter is not used, the entire segment of the URL corresponding to that parameter must also be removed.

Authorizations:
api_key
path Parameters
from
required
string <date-time>
Example: 2021-12-01T12:00:00

Earliest date of sale for transactions to fetch.

until
required
string <date-time>
Example: 2021-12-15T12:00:00

Latest date of sale for transaction to fetch.

page
required
integer
Default: 1
Example: 1

The page to return for the current filter and page size.

size
required
integer
Default: 50
Example: 100

Number of items on one page. The maximum amount of items for a single page may be limited by system settings.

cash-register
required
integer
Example: 1

Id of cashregister. If omitted transactions for all cashregister allowed to access will be returned.

Responses

Response samples

Content type
application/json
[
  • {
    }
]