Skip to main content
GET
/
scanner
/
api
/
v1
/
sessions
/
{public_id}
Get session details
curl --request GET \
  --url https://www.closient.com/scanner/api/v1/sessions/{public_id} \
  --cookie sessionid=
{
  "public_id": "<string>",
  "status": "<string>",
  "capture_mode": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "captures": [
    {
      "public_id": "<string>",
      "status": "<string>",
      "capture_type": "<string>",
      "raw_value": "<string>",
      "gtin": "<string>",
      "error_message": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "gs1_dl_data": {},
      "product_public_id": "<string>",
      "product_name": "<string>",
      "processed_at": "2023-11-07T05:31:56Z",
      "uploaded_image_key": "<string>"
    }
  ],
  "product_photos": [
    {
      "public_id": "<string>",
      "photo_type": "<string>",
      "s3_key": "<string>",
      "original_filename": "<string>",
      "sort_order": 123,
      "created": "2023-11-07T05:31:56Z",
      "file_size": 123,
      "capture_public_id": "<string>"
    }
  ]
}

Authorizations

sessionid
string
cookie
required

Path Parameters

public_id
string
required

Unique session public_id identifier.

Response

OK

Detailed scan session with all captures and product photos.

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.

captures
CaptureResponseSchema · object[]
required

List of captures in this session.

product_photos
ProductPhotoResponseSchema · object[]

Product photos taken during this session.