Skip to main content

API Reference (v2)

Base URL: https://api.action-target.net/api/v2/pos

Swagger Documentation:


Range Information

Caching Recommendation: Query bays, lanes, and groups once on POS application startup and cache the results. Configuration changes are rare, so refreshing no more than once per day is sufficient.

GET /bays

Returns a list of bays for your range. Bays are organizational containers that group lanes together.

Response: Array of BayView

GET /groups

Returns the access groups configured for your range.

Response: Array of GroupView

GET /lanes

Returns a list of lanes for your range. Results are ordered in the expected display order but are not grouped by bay—your application must handle grouping if needed.

Response: Array of LaneView


Session Management

GET /sessions

Returns all active sessions.

Response: Array of SessionView

GET /sessions/{id}

Returns details for a specific session.

Response: SessionView

POST /sessions

Creates a new session.

Request Body:

{
"customer_name": "John Doe",
"lane_id": "string (UUID)",
"group_id": "string (UUID)",
"duration": 30,
"enable_purchasing": true,
"auto_start": true
}
FieldDescription
durationSession length in minutes. Minimum: 1, Maximum: 480 (8 hours).
enable_purchasingOptional (default: false). Enables lane purchasing if the range supports it.
auto_startIf false, session time does not start counting down until the user enters the lane.

Response: SessionView

POST /sessions/{id}/modify?time=15

Adds or removes time from an existing session.

Parameters:

  • id: Session ID (UUID)
  • time: Minutes to add (positive) or remove (negative)

Response: 204 No Content

POST /sessions/{id}/stop

Stops an active session.

Parameters:

  • id: Session ID (UUID)

Response: 204 No Content