API docs by Redocly

External data delivery (1.0.0)

Download OpenAPI specification:

E-mail: api@oktopos.com

API for managing external data delivery.

Authentication

All endpoints in this API require a valid authentication token.

Retrieving Your Token

You can obtain your authentication token in your instance of OktoPOS Manager:

  1. Log in to your OktoPOS Manager.
  2. Navigate to System under the OktoPOS menu.

Base URL

All paths mentioned in this API documentation must be prefixed with the Base URL specified under info/servers/url in this document.

Record dispensed items for a device.

This endpoint records dispensed items for a specific device.

A JSON array must be provided in the request body, where each product is referenced by its assigned product code in the article record.

Authorizations:
api_key
path Parameters
deviceId
required
string

The unique identifier of the device.

Request Body schema: application/json
required
Array
productCode
required
string

Unique identifier for the product. A device specific product code.

productName
string

The name of the dispensed product.

amount
required
number <float>

The amount of product dispensed.

unit
string

The unit in which the product amount is measured. Only the following abbreviations of SI-Units are allowed: l (liters), ml (milliliters), g (grams), kg (kilograms), mg (milligrams). If no unit is given, the base unit of the referenced article will be used.

effectiveTime
required
string <date-time>

The time at which the dispensing occurred. A date in ATOM format is expected (e.g., '2023-10-18T10:20:30Z').

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]