Register a product photo

curl --request POST \
  --url https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "s3_key": "<string>",
  "metadata": {},
  "photo_type": "other",
  "capture_short_id": "<string>",
  "original_filename": "",
  "file_size": 123
}
'

import requests

url = "https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos"

payload = {
    "s3_key": "<string>",
    "metadata": {},
    "photo_type": "other",
    "capture_short_id": "<string>",
    "original_filename": "",
    "file_size": 123
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    s3_key: '<string>',
    metadata: {},
    photo_type: 'other',
    capture_short_id: '<string>',
    original_filename: '',
    file_size: 123
  })
};

fetch('https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos', 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/{session_id}/photos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    's3_key' => '<string>',
    'metadata' => [
        
    ],
    'photo_type' => 'other',
    'capture_short_id' => '<string>',
    'original_filename' => '',
    'file_size' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos"

	payload := strings.NewReader("{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

POST

scanner

api

sessions

{session_id}

photos

curl --request POST \
  --url https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "s3_key": "<string>",
  "metadata": {},
  "photo_type": "other",
  "capture_short_id": "<string>",
  "original_filename": "",
  "file_size": 123
}
'

import requests

url = "https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos"

payload = {
    "s3_key": "<string>",
    "metadata": {},
    "photo_type": "other",
    "capture_short_id": "<string>",
    "original_filename": "",
    "file_size": 123
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    s3_key: '<string>',
    metadata: {},
    photo_type: 'other',
    capture_short_id: '<string>',
    original_filename: '',
    file_size: 123
  })
};

fetch('https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos', 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/{session_id}/photos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    's3_key' => '<string>',
    'metadata' => [
        
    ],
    'photo_type' => 'other',
    'capture_short_id' => '<string>',
    'original_filename' => '',
    'file_size' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos"

	payload := strings.NewReader("{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"s3_key\": \"<string>\",\n  \"metadata\": {},\n  \"photo_type\": \"other\",\n  \"capture_short_id\": \"<string>\",\n  \"original_filename\": \"\",\n  \"file_size\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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

X-API-Key

string

header

required

Path Parameters

session_id

string

required

Unique session short_id identifier.

Body

application/json

Request body for registering a product photo.

s3_key

string

required

S3 object key returned by the presigned upload.

metadata

Metadata · object | null

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

Show child attributes

photo_type

enum<string>

default:other

Classification label — which side or aspect of the product this photo shows. Drives routing through the vision pipeline (e.g. nutrition photos go to the nutrition-facts extractor). Defaults to other when the operator does not assign a label.

Available options:

front,

back,

left,

right,

top,

bottom,

nutrition,

ingredients,

barcode,

recycling,

certification,

other

capture_short_id

string | null

Slug of the barcode capture to link this photo to.

original_filename

string

default:""

Original filename as provided by the client.

file_size

integer | null

File size in bytes.

Response

Created

A single product photo in a scan session gallery.

photo_type

enum<string>

required

Classification label — which side or aspect of the product this photo shows. Drives routing through the vision pipeline (e.g. nutrition photos go to the nutrition-facts extractor).

Available options:

front,

back,

left,

right,

top,

bottom,

nutrition,

ingredients,

barcode,

recycling,

certification,

other

s3_key

string

required

S3 object key for the photo file.

original_filename

string

required

Original filename.

sort_order

integer

required

Display position.

created

string<date-time>

required

Timestamp when the photo was registered.

metadata

Metadata · object

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

Show child attributes

file_size

integer | null

File size in bytes.

capture_short_id

string | null

Slug of the linked barcode capture.

Overview

Account

Products

Brands

Locations

Retailers

Search

GS1 Digital Link

EPCIS 2.0

Integrations

Billing

Scanner

Compliance

Certifications

Sustainability

Notifications

Dashboard

Analytics

Agent

Substances

BYOS

Content

Signals

Register a product photo

Authorizations

Path Parameters

Body

Response