createRegister

mutation · in the family Register

What it does

Create a new register — one till position a device drives at your organization.

Create a Register — a logical till position at an LF; requires the unrestricted capability.

Who may call it

Capability area: System and integration setup — Registers, connections and the settings your systems run on.

Owner
System Administrator
An API key whose scope allows api:createRegister

Arguments

Name	Type	Required	Notes
`input`	NewRegisterInput `NewRegisterInput!`	yes	No further notes.

Returns

Register Register! — A Register — a POS terminal / till position at a LogicalFacility: the LOGICAL till identity TillSessions parent to (physical device pairing =, one-way Device→Register — never stored here). The OPERATIONAL lifecycle verbatim. The gate: a LIVE TillSession (open/suspended/counting) blocks deactivate AND doom, CONFLICT/REFERENCED naming it; terminal sessions never block.

Example request

mutation ExampleCreateRegister($input: NewRegisterInput!) {
  createRegister(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    code
  }
}

Variables:

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

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

Example response

{
  "data": {
    "createRegister": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RG-EXMP-0000-000F",
      "type": "Register",
      "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",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "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)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

Set up a register position — and shut a lost till off