Scan any item type in or out of a zone using NFC or QR codes. This endpoint uses real-time validation checks to ensure that any of the pre-configured zone restrictions cannot be bypassed.
The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.
Request body for scanning a ticket into a zone
Optional UUID to ensure items are not scanned multiple times. If a matching UUID is found, it is assumed that all tickets have already been scanned and the system will return the response from the previous successful scan with the matching UUID and not attempt to scan any of the tickets provided.
The item barcode(s). Can accept multiple barcodes in a single request, however the scan is all-or-nothing so if one barcode is denied, none of the barcodes will be admitted. Barcodes will be ignored if an array of NFC ID's are given.
A list of NFC ID's that are currently paired with purchased tickets. When given, this will always take precedence over the barcodes attribute. Can accept multiple NFC ID's in a single request, however the scan is all-or-nothing so if one NFC ID is denied, none of the tickets associated with the given NFC ID's will be admitted.
The ID of the zone that you are scanning in/out of.
A list of sale item IDs that should be considered 'disabled' for the purposes of scanning.
The scan mode
in, out, auto Specifies that the barcodes sent in this request are the final choice for scanning, thus skipping checks to see if any child items are also eligible to enter this zone. Only applicable to zones with 'precision scanning' enabled.
The latitude of the scanning device
The longitude of the scanning device
Force the scan regardless of any age restrictions that may be set on the zone
Force the scan regardless of the capacity that may be set on the zone
Successful zone scan request.
valid, alreadyIn, alreadyOut, denied, zoneClosed, ageUnknown, tooYoung, tooOld, full, scansInExceeded, requiresConfirmation historicBarcode, itemDoesNotQualify, outsideOfValidityPeriod, orderLocked