Skip to main content
POST
/
scanner
/
api
/
v1
/
sessions
Create a scan session
curl --request POST \
  --url https://www.closient.com/scanner/api/v1/sessions \
  --header 'Content-Type: application/json' \
  --cookie sessionid= \
  --data '
{
  "organization_public_id": "<string>",
  "user_agent": "",
  "device_context": {},
  "capture_mode": "barcode_scan"
}
'
{
  "public_id": "<string>",
  "status": "<string>",
  "capture_mode": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "capture_count": 0,
  "photo_count": 0
}

Authorizations

​
sessionid
string
cookie
required

Body

application/json

Request body for creating a new scan session.

​
organization_public_id
string
required

Organization public_id to associate the session with.

​
user_agent
string
default:""

Browser user-agent string of the scanning device.

​
device_context
Device Context · object

Device metadata.

​
capture_mode
string
default:barcode_scan

Capture mode for this session.

Pattern: ^(barcode_scan|product_photography|both)$

Response

Created

Scan session summary.

​
public_id
string
required

Unique session identifier.

​
status
string
required

Session status.

​
capture_mode
string
required

Session capture mode.

​
created
string<date-time>
required

Timestamp when the session was created.

​
modified
string<date-time>
required

Timestamp when the session was last modified.

​
capture_count
integer
default:0

Total number of captures.

​
photo_count
integer
default:0

Total number of product photos.