Find Scanners

GET

https://api.npretail.app/:tenant/:environment/:company/speedgate

GET

/:tenant/:environment/:company/speedgate

$ curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%2520International%2520Ltd./speedgate \
>      -H "x-np-api-key: <NaviPartner API Key>" \
>      -d scannerId=GATE*

200List of scanners defined

1 {
2   "scanners": [
3     {
4       "id": "12345678-aaaa-12d3-a456-426614174000",
5       "scannerId": "GATE1",
6       "description": "This is a description",
7       "category": {
8         "id": "c2608dfa-5c02-427c-ac40-df538cb98d2f",
9         "code": "ENTRANCE",
10         "name": "Entrance Scanners"
11       }
12     }
13   ],
14   "requireScannerId": true,
15   "permitTickets": true,
16   "permitMemberCards": true,
17   "permitWallets": true,
18   "imageProfileCode": "IMAGES-1",
19   "ticketProfileCode": "TICKETS-1",
20   "memberCardProfileCode": "CARDS-1",
21   "items": [
22     {
23       "itemNo": "31001",
24       "description": "This is a description",
25       "presentationOrder": 1,
26       "description2": "This is a description"
27     }
28   ]
29 }

This endpoint retrieves a list of all scanners registered within the specified company.

Scanner Id Filter
The ScannerId parameter allows you to filter the list by scanner Id. It supports wildcards, enabling partial matches to retrieve multiple related scanners efficiently.

Authentication

x-np-api-keystring

API Key authentication via header

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired

Your Business Central Company. More details.

Query parameters

scannerIdstringRequired

A human friendly unique code that identifies a specific speedgate. Supports filtering such as * for wildcard matching f.ex. GATE*

Response

Returns a list of scanners matching the specified filter criteria.

scannerslist of objects

requireScannerIdbooleanOptional

Indicates if the speedgate requires a scanner id when scanning a reference number. When not providing a scanner id, a set of default profiles will be used for configuration.

permitTicketsbooleanOptional

Indicates if the scanner will permit tickets when scanned.

permitMemberCardsbooleanOptional

Indicates if the scanner will permit member cards when scanned.

permitWalletsbooleanOptional

Indicates if the scanner will permit wallets when scanned.

imageProfileCodestringOptional

Code representing the image profile.

ticketProfileCodestringOptional

Code representing the ticket profile.

memberCardProfileCodestringOptional

Code representing the member card profile.

itemslist of objectsOptional

Authentication

Path parameters

Headers

Query parameters

Response