iRetail PRO store node 1.0.0-m1: events
2 operations
← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.
← iRetail PRO store node 1.0.0-m1
Operations
GET
/v1/events
Events after a sequence number (spec/API.md).
Only events whose type's read permission the caller holds (spec/API.md, Events; data/event-permissions.json), so the seq values a caller sees have gaps.
operationId
listEvents · Permission events.read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
after
|
query | integer (int64) |
Last seq processed; 0 for the start. |
limit
|
query | integer |
Page size, 1–200. |
Responses
GET
/v1/events/stream
WebSocket upgrade; each message is one event (envelope).
Only events whose type's read permission the caller holds (spec/API.md, Events; data/event-permissions.json). The token is checked again at least every 60 seconds and on revocation; at most 4 streams per token (429 too_many_requests, details limit streams).
operationId
streamEvents · Permission events.read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
IRetail-App
|
header | string |
Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking). |
after
|
query | integer (int64) |
Last seq processed. |
Responses
Schemas
Error object
Every error response.
error required
|
string |
Stable code, see spec/API.md. |
message required
|
string |
English text for logs. |
details
|
object |
Event @envelope.schema.json
EventPage object
items required
|
array of Event |
|
last_seq required
|
integer (int64) |
Pass as after= to continue. |