iRetail PRO store node 1.0.0-m1: pharmacy

2 operations

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

← iRetail PRO store node 1.0.0-m1

Operations

GET /v1/pse/log The pseudoephedrine logbook, newest first (spec/PHARMACY.md).

operationId listPseLog · Permission pse.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).
from required query string (date) First business date, inclusive.
to required query string (date) Last business date, inclusive.
limit query integer Page size, 1–200.
after query string Cursor from the previous page.

Responses

GET /v1/pse/log/export The pseudoephedrine logbook of a period as CSV.

operationId exportPseLog · Permission pse.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).
from required query string (date) First business date, inclusive.
to required query string (date) Last business date, inclusive.

Responses

  • 200 The file. string
  • 400 Error (spec/API.md). Error
  • 401 Error (spec/API.md). Error
  • 403 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

PsePurchaser object

The purchaser of a PSE product as the scanned ID gives it (spec/PHARMACY.md, "The purchaser").

name required string
address required string
date_of_birth required string (date)
id_type required "driver_license" | "state_id" | "passport" | "military_id" | "other"
id_state required string The issuing state or country, as printed.
id_number required string
signed required boolean The purchaser signed the logbook entry.

PseLogEntry object

id required string (uuid)
receipt_id required string (uuid)
receipt_number required integer (int64)
business_date required string (date)
created_at required string (date-time)
employee_id required string (uuid)
lines required array of object
base_mg required integer The entry's milligrams of base, negative for a refund.
purchaser required PsePurchaser

PseLogPage object

items required array of PseLogEntry
next required string | null