Introduction
What POS actions are and how to call them
POS actions let your integration send an action directly to the point-of-sale (POS) device of a specific branch. The targeted device must be online and turned on to process the action. The result of processing is not returned in the HTTP response body — instead, it is delivered to a webhook.
Actions are sent with a single request:
POST https://api.dotykacka.cz/v2/clouds/:cloudId/branches/:branchId/pos-actions
The cloudId and branchId path parameters identify the cloud and the branch whose device should perform the action.
The endpoint returns 200 OK with an empty body. Use the code field in the webhook response to determine the actual result of the action.
What you can do
POS actions allow you to drive everyday operations on the till, such as:
- Creating and updating orders
- Adding items to an order
- Splitting orders
- Issuing orders and paying issued orders
- Combined flows like create-issue and create-issue-pay
- Canceling orders and changing order status
For the full catalog of actions, their request formats, parameters and result codes, see the Actions reference.
Authorization
POS actions use the same authorization as the rest of the Dotypos API v2. Each request must include an Authorization header with a bearer access token:
Authorization: Bearer accessTokenFor details on obtaining an access token, see the API v2 Authorization documentation. If you are new to the API, the Getting started guide is a good place to begin.