AlmondTill/G3N API

On this page

devicePeripheral

query · in the family Device peripheral

What it does

Look up one record — a device peripheral — a printer, scanner, or card reader on a device.

A DevicePeripheral by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

What happens

Reads only — changes nothing.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

DevicePeripheral — A DevicePeripheral — the hardware a Device OWNS: barcode scanners, receipt/label printers, display poles, cash drawers, card readers, and scales. The model MUST name the AT-maintained preset registry (cannedPeripheralModels, registry v2 — merchants pick supported models, never author drivers); peripheralType + model are IMMUTABLE at birth (swapped hardware = a new peripheral), connection is mutable (re-cabling is an edit). NOT searchable (hardware config — reached via its owning Device).

Example request

query ExampleDevicePeripheral($id: ID!) {
  devicePeripheral(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    peripheralType
    model
    connection
    readerRef
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "devicePeripheral": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PH-EXMP-0000-000F",
      "type": "DevicePeripheral",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "peripheralType": "barcode_scanner",
      "model": "<model>",
      "connection": "native_usb",
      "readerRef": "<reader ref>"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer