Skip to main content
GET
/
scanner
/
api
/
v1
/
sessions
/
{id}
Get session details
curl --request GET \
  --url https://www.closient.com/scanner/api/v1/sessions/{id} \
  --header 'X-API-Key: <api-key>'
{
  "status": "ACTIVE",
  "capture_mode": "barcode_scan",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "captures": [
    {
      "status": "PENDING",
      "capture_type": "BARCODE",
      "raw_value": "<string>",
      "gtin": "<string>",
      "error_message": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "metadata": {},
      "gs1_dl_data": {},
      "product_short_id": "<string>",
      "product_name": "<string>",
      "processed_at": "2023-11-07T05:31:56Z",
      "uploaded_image_key": "<string>",
      "qr_analysis": {}
    }
  ],
  "metadata": {},
  "product_photos": [
    {
      "photo_type": "front",
      "s3_key": "<string>",
      "original_filename": "<string>",
      "sort_order": 123,
      "created": "2023-11-07T05:31:56Z",
      "metadata": {},
      "file_size": 123,
      "capture_short_id": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<shortuuid>
required

Unique session id identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

Detailed scan session with all captures and product photos.

​
status
enum<string>
required

Lifecycle state of the session. ACTIVE while the operator is still adding captures; COMPLETED once they explicitly end or submit it; EXPIRED if a maintenance job reaped the session after sitting idle past its TTL.

Available options:
ACTIVE,
COMPLETED,
EXPIRED
​
capture_mode
enum<string>
required

Session capture mode.

Available options:
barcode_scan,
product_photography,
both
​
created
string<date-time>
required

Timestamp when the session was created.

​
modified
string<date-time>
required

Timestamp when the session was last modified.

​
captures
CaptureResponseSchema · object[]
required

List of captures in this session.

​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
product_photos
ProductPhotoResponseSchema · object[]

Product photos taken during this session.