POST
Request a cash register computer link
No sign-in needed For: Integrator Conditions
  • registration_key must be the company’s cash registration key; an unknown key is refused.
  • company_id is prohibited; the company comes from the key.
  • If pos_sync_instance_id is given, it must be an active POS device of the register’s organization on the same computer; otherwise 422.
  • No active device may already exist for this machine on this register; otherwise 409.
  • Only one open request (pending, or approved and not completed) per machine, by computer or host fingerprint, on the same register; otherwise 409.
  • The route is limited to 10 calls per minute.
What else happens
  • Creates a pending request and returns a one-time request token; only its hash is stored.
Part of Connect cash register computers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
registration_key
string
required

The company's cash registration key (26-character ULID). Required; it identifies the company and must exist.

Required string length: 26
cash_register_id
string
required

Identifier of the cash register (27-character KSUID) the machine asks to be linked to. Required; must belong to the company found from the key.

Required string length: 27
name
string
required

Display name of the machine, up to 120 characters. Required.

Maximum string length: 120
computer_id
string
required

Stable identifier of the computer, up to 255 characters. Required.

Maximum string length: 255
host_fingerprint
string
required

Fingerprint of the host, up to 255 characters. Required; stored only as a hash.

Maximum string length: 255
company_id
string

Identifier of the company the record belongs to.

pos_sync_instance_id
string | null

Optional identifier of the POS sync device already active on the same computer in the register's organization. If given and not active on that computer, the request is refused.

Required string length: 27
platform
enum<string> | null

Operating system of the machine: darwin, win32 or linux. Optional.

Available options:
darwin,
win32,
linux

Response

CashInstanceRegistrationSubmissionResource

data
CashInstanceRegistrationSubmissionResource · object
required

Items of this page.