Skip to main content
GET
/
products
/
api
/
v1
/
trade-items
/
{gtin}
Get trade item detail
curl --request GET \
  --url https://www.closient.com/products/api/v1/trade-items/{gtin} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "gtin": "<string>",
  "product_name": "<string>",
  "brand": "<string>",
  "manufacturer": "<string>",
  "description": "<string>",
  "image_url": "<string>",
  "country_of_origin": "<string>",
  "net_content": "<string>",
  "is_claimed": true,
  "confidence_score": 0.5,
  "primary_language": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "field_confidence": {},
  "usage_instructions": "<string>",
  "brand_product_page_url": "<string>",
  "ai_summary": "<string>",
  "modified": "2023-11-07T05:31:56Z",
  "net_content_value": 123,
  "owner_id": "<string>",
  "countries_sold": [
    "<string>"
  ],
  "length": 123,
  "length_uom": "",
  "width": 123,
  "width_uom": "",
  "height": 123,
  "height_uom": "",
  "depth": 123,
  "depth_uom": "",
  "gross_weight": 123,
  "gross_weight_uom": "",
  "net_weight": 123,
  "net_weight_uom": "",
  "gpc_brick_code": "",
  "gpc_class_code": "",
  "gpc_family_code": "",
  "gpc_segment_code": ""
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
gtin
string
required

GTIN barcode (8, 12, 13, or 14 digits, with or without separators). Normalized to GTIN-14 for lookup.

Response

200 - application/json

OK

Full trade-item record returned by GET /trade-items/{gtin}.

Extends :class:TradeItemOut with GDSN dimension/weight pairs, GS1 Global Product Classification (GPC) codes, per-field confidence, usage instructions, the brand product page URL, and the AI-generated summary.

​
id
string<shortuuid>
required

Internal trade-item identifier (UUID).

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

Normalized GTIN-14 (zero-padded). Stable across the catalog regardless of input format.

Required string length: 14
Pattern: ^\d{14}$
​
product_name
string
required

Display name as marketed on the packaging.

​
brand
string
required

Brand name resolved from the linked Brand record. Empty string when no brand is linked.

​
manufacturer
string
required

Manufacturer name resolved from the linked Manufacturer record. Empty string when no manufacturer is on file.

​
description
string
required

Long-form product description. May be empty.

​
image_url
string
required

Absolute URL of the primary product image. Empty string when none on file.

​
country_of_origin
string
required

ISO 3166-1 alpha-2 country code identifying where the product was made. Empty string when unknown.

Maximum string length: 2
​
net_content
string
required

Free-text net content as printed on the package (e.g. 340g). Use net_content_value + net_content_uom for the structured pair.

​
is_claimed
boolean
required

True when the GTIN has been claimed by a brand owner (i.e. the linked Brand belongs to an Organization).

​
data_source
enum<string>
required

Provenance of the canonical record (e.g. crowd_sourced, open_food_facts, claimed once a brand owner takes ownership).

Available options:
crowd_sourced,
claimed,
imported,
ai_extracted,
brand_site_crawl,
gtin1_authoritative,
external_api,
open_food_facts,
usda_fdc,
fda_ndc,
affiliate_feed,
datakick,
common_crawl_wdc
​
confidence_score
number
required

Aggregate confidence score across all canonical fields, derived from contribution agreement.

Required range: 0 <= x <= 1
​
primary_language
string
required

ISO 639-1 language code identifying the product's primary language. Empty string when unknown.

Maximum string length: 10
​
created
string<date-time>
required

ISO 8601 timestamp of when the product record was created in Closient.

​
field_confidence
Field Confidence · object
required

Per-field confidence map, e.g. {"product_name": 0.98, "brand": 0.95}. Each value is in the range 0.0 - 1.0.

​
usage_instructions
string
required

Directions or instructions for use, as printed on the package. May be empty.

​
brand_product_page_url
string
required

Absolute URL of the brand's canonical product page. Empty string when unknown.

​
ai_summary
string
required

AI-generated product summary suitable for resolver pages. Empty string when not generated yet.

​
modified
string<date-time>
required

ISO 8601 timestamp of when the trade-item record was last updated.

​
net_content_value
number | null

Structured numeric net content (e.g. 340 for 340g). Null when no structured value has been parsed.

​
net_content_uom
enum<string> | null

UN/CEFACT unit code paired with net_content_value. Null when no structured value has been parsed; expect the empty string on legacy records pending a backfill.

Available options:
MLT,
CLT,
LTR,
GRM,
KGM,
ONZ,
LBR,
PTI,
QTI,
GLL,
EA
​
owner_id
string<shortuuid> | null

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

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

List of ISO 3166-1 alpha-2 country codes where the product is sold. Empty list when unknown.

​
length
number | null

Product length in the unit specified by length_uom. Null when the dimension is unknown.

​
length_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired dimension (e.g. CMT centimetre, MMT millimetre, MTR metre). Empty string when the dimension is unknown.

Maximum string length: 10
​
width
number | null

Product width in the unit specified by width_uom. Null when the dimension is unknown.

​
width_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired dimension (e.g. CMT centimetre, MMT millimetre, MTR metre). Empty string when the dimension is unknown.

Maximum string length: 10
​
height
number | null

Product height in the unit specified by height_uom. Null when the dimension is unknown.

​
height_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired dimension (e.g. CMT centimetre, MMT millimetre, MTR metre). Empty string when the dimension is unknown.

Maximum string length: 10
​
depth
number | null

Product depth in the unit specified by depth_uom. Null when the dimension is unknown.

​
depth_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired dimension (e.g. CMT centimetre, MMT millimetre, MTR metre). Empty string when the dimension is unknown.

Maximum string length: 10
​
gross_weight
number | null

Gross weight (product + packaging) in the unit specified by gross_weight_uom. Null when unknown.

​
gross_weight_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired weight (e.g. GRM gram, KGM kilogram, LBR pound, ONZ ounce). Empty string when the weight is unknown.

Maximum string length: 10
​
net_weight
number | null

Net weight (product only, excluding packaging) in the unit specified by net_weight_uom. Null when unknown.

​
net_weight_uom
string
default:""

UN/CEFACT recommendation 20/21 unit code for the paired weight (e.g. GRM gram, KGM kilogram, LBR pound, ONZ ounce). Empty string when the weight is unknown.

Maximum string length: 10
​
gpc_brick_code
string
default:""

GS1 Global Product Classification 8-digit brick code (the most specific level). Empty string when the product has not been classified.

Maximum string length: 8
Pattern: ^(\d{8})?$
​
gpc_class_code
string
default:""

GS1 Global Product Classification class code (parent of brick). Empty string when unclassified.

Maximum string length: 8
Pattern: ^(\d{8})?$
​
gpc_family_code
string
default:""

GS1 Global Product Classification family code (parent of class). Empty string when unclassified.

Maximum string length: 8
Pattern: ^(\d{8})?$
​
gpc_segment_code
string
default:""

GS1 Global Product Classification segment code (top-level category). Empty string when unclassified.

Maximum string length: 8
Pattern: ^(\d{8})?$