iRetail PRO
Русский Get a key
Menu

iRetail PRO store node 1.0.0-m1: me

2 operations

← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.

← iRetail PRO store node 1.0.0-m1

Operations

GET /v1/me The caller and its effective permissions in its context.

operationId me

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).

Responses

  • 200 OK Me
  • 401 Error (spec/API.md). Error
PUT /v1/me/pin Set a new PIN for the signed-in employee, giving the current one (spec/RBAC.md, PINs).

An employee's session only; the current PIN counts as an attempt of the session's device. The only change a session with pin_change_required may make. A store of a chain carries it out at its hub (spec/SYNC.md, Forwarded operations).

operationId changeOwnPin

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).

Request body required

Responses

  • 204 Done
  • 400 Error (spec/API.md). Error
  • 401 Error (spec/API.md). Error
  • 403 Error (spec/API.md). Error
  • 429 Error (spec/API.md). Error
  • 503 Error (spec/API.md). Error

Schemas

Error object

Every error response.

error required string Stable code, see spec/API.md.
message required string English text for logs.
details object

Principal object

kind required "employee" | "device" | "integration"
id required string (uuid)
display_name required string

EffectivePermission object

code required string
limit required integer (int64) | null

Me object

principal required Principal
store_id required string (uuid)
workplace_id required string (uuid) | null
permissions required array of EffectivePermission

PinChange object

current_pin required string
pin required string