cannedPeripheralModels

query · in the family Reading your records

What it does

The platform’s supported-hardware presets — the printers, scanners, and card readers Almond Till knows how to drive. A device peripheral names one of these.

The AT-maintained preset peripheral-model roster: every model names its peripheralType + supported connections; createDevicePeripheral must cohere with a row. Unpaginated bounded roster (not a construct list). Requires authentication.

What happens

Reads only.

Who may call it

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

• Owner
• System Administrator
• Manager
• Associate Manager
• Warehouse Associate
• Sales Associate
• An API key whose scope allows api:cannedPeripheralModels

Returns

PeripheralModel [PeripheralModel!]! — One preset peripheral model.

Example request

query ExampleCannedPeripheralModels {
  cannedPeripheralModels {
    model
    caption
    peripheralType
    connections
  }
}

Example response

{
  "data": {
    "cannedPeripheralModels": [
      {
        "model": "<model>",
        "caption": "Blue jeans",
        "peripheralType": "barcode_scanner",
        "connections": [
          "native_usb"
        ]
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)