Skip to main content
GET
Get session details

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

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.