Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

How the web app reads the member's keyboard-wedge barcode scanner. Every value is replaced.

gap_ms
integer
required

The longest pause between two characters of one scan, in milliseconds, from 10 to 80. The default is 50.

Required range: 10 <= x <= 80
min_length
integer
required

The fewest characters that make a scan, from 3 to 12. The default is 4.

Required range: 3 <= x <= 12
screen_reader
boolean
required

Whether the member uses a screen reader.

prefix
string | null

A key or string of up to 8 characters after which everything typed is read as a scan, whatever the timing. Send null for none.

Maximum string length: 8
gs_replacement
string | null

What the scanner types in place of the GS1 group separator (ASCII 29), up to 4 characters, such as ~. Send null for none.

Maximum string length: 4
tones
boolean | null

Whether to play a sound on each scan. Send null to follow the screen_reader choice.

Response

ScannerPreferencesResource

data
ScannerPreferencesResource · object
required

How the web app reads the member's keyboard-wedge barcode scanner.