Skip to main content
GET
List and filter a product's documents

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.

Pattern: ^[0-9]{8,14}$

Query Parameters

purpose
enum<string>[]

Repeatable. OR'd together.

Available options:
gs1:certificationInfo,
gs1:epil,
gs1:instructions,
gs1:quickStartGuide,
gs1:recipeInfo,
gs1:safetyInfo,
gs1:traceability,
gs1:whatsInTheBox
language
string[]

Repeatable. OR'd together, BCP 47 fallback.

Pattern: ^[a-z]{2,3}(-[A-Z][a-z]{3})?(-([A-Z]{2}|\d{3}))?(-([0-9A-Za-z]{5,8}|\d[0-9A-Za-z]{3}))*$
market
string

A document with no markets set matches every market.

Pattern: ^[A-Za-z]{2}$
format
enum<string>

Media-type bucket.

Available options:
pdf,
video,
web_page,
image,
other
label
string[]

Repeatable. OR'd together, matched case-insensitively/lowercased.

Pattern: ^[^\x00]{0,}$

Response

OK

List response: matching documents plus the facet summary for the current query.

documents
ProductDocumentOut · object[]
required

Matching documents, sorted pinned-first / purpose / sort_order / title.

facets
DocumentFacetSummaryOut · object
required

Available facet values and counts for this result set.

Example: