Connect a till

Bring a point-of-sale device online — enroll it, pair it, and bind it to its register.

POS estate · a play in 3 steps.

The steps

1. Enroll the device at the location where it will transact. — enrollDevice
2. Complete the pairing handshake from the device itself. — completePairingDevice
3. Bind the paired device to the register position it serves. — pairDeviceToRegister

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

enrollDevice

enrollDevice — mutation · Enroll a device — register a till, terminal, or bridge and get its one-time pairing code.

Example request

mutation ExampleEnrollDevice($input: EnrollDeviceInput!) {
  enrollDevice(input: $input) {
    pairingCode
    pairingCodeExpiresAt
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
    "deviceType": "pos_native_ios_phone"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "enrollDevice": {
      "pairingCode": "BJ-001",
      "pairingCodeExpiresAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

completePairingDevice

completePairingDevice — Reserved for the platform; not available to API keys.

pairDeviceToRegister

pairDeviceToRegister — mutation · Point a POS device at a register — which drawer this till drives.

Example request

mutation ExamplePairDeviceToRegister($input: PairDeviceToRegisterInput!) {
  pairDeviceToRegister(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    deviceType
    registerId
    code
  }
}

Variables:

{
  "input": {
    "deviceId": "01900000-0000-7000-8000-7c291d9e0000",
    "registerId": "01900000-0000-7000-8000-c30413dd0000",
    "expectedRevision": "01900000-0000-7000-8000-e02b2e6c0000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "pairDeviceToRegister": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DE-EXMP-0000-000F",
      "type": "Device",
      "caption": "Blue jeans",
      "status": "pending_pairing",
      "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",
      "deviceType": "pos_native_ios_phone",
      "registerId": "01900000-0000-7000-8000-c30413dd0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}