Skip to main content
GET
/
locations
/
{locationId}
/
registers
/
status
Get status for all registers at a location
curl --request GET \
  --url https://api.openfiskal.com/v1/locations/{locationId}/registers/status \
  --header 'Authorization: Bearer <token>'
{
  "location_id": "<string>",
  "data": [
    {
      "register_id": "<string>",
      "status": "operational",
      "last_heartbeat_at": "2023-11-07T05:31:56Z",
      "open_operations": [
        {
          "id": "<string>",
          "type": "sale",
          "started_at": "2023-11-07T05:31:56Z"
        }
      ],
      "unsynced_operations": 123,
      "software": {
        "pos_vendor": "<string>",
        "pos_version": "<string>",
        "agent_version": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Platform API key sent as Authorization: Bearer ofk_platform_.... Platform integrators also pass OpenFiskal-Organization: org_xxx to act on behalf of a merchant.

Path Parameters

locationId
string
required

Response

Register status overview

location_id
string
data
object[]