Get session details
curl --request GET \
--url https://www.closient.com/scanner/api/v1/sessions/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://www.closient.com/scanner/api/v1/sessions/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://www.closient.com/scanner/api/v1/sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/scanner/api/v1/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/scanner/api/v1/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/scanner/api/v1/sessions/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/scanner/api/v1/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"captures": [
{
"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": [
{
"s3_key": "<string>",
"original_filename": "<string>",
"sort_order": 123,
"created": "2023-11-07T05:31:56Z",
"metadata": {},
"file_size": 123,
"capture_short_id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}Scanner Sessions
Get session details
Retrieve detailed session information including all captures and product photos.
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>'import requests
url = "https://www.closient.com/scanner/api/v1/sessions/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://www.closient.com/scanner/api/v1/sessions/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/scanner/api/v1/sessions/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/scanner/api/v1/sessions/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.closient.com/scanner/api/v1/sessions/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/scanner/api/v1/sessions/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"captures": [
{
"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": [
{
"s3_key": "<string>",
"original_filename": "<string>",
"sort_order": 123,
"created": "2023-11-07T05:31:56Z",
"metadata": {},
"file_size": 123,
"capture_short_id": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"retryable": true,
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
APIKeyHeaderAuthOAuthTokenAuthCookieGatedSessionAuth
Path Parameters
Unique session id identifier.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Response
OK
Detailed scan session with all captures and product photos.
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 Session capture mode.
Available options:
barcode_scan, product_photography, both Timestamp when the session was created.
Timestamp when the session was last modified.
List of captures in this session.
Show child attributes
Show child attributes
Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.
Show child attributes
Show child attributes
Product photos taken during this session.
Show child attributes
Show child attributes
⌘I