Skip to main content
PATCH
Update a document's facets and metadata

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}$
document_id
string
required

UUID (or 22-char shortuuid) of the document row. Must belong to the targeted product.

Body

application/json

Facet/metadata patch. To replace the underlying file or link, create a new document instead.

purpose
enum<string> | null

GS1 link type CURIE this document is filed under.

Available options:
gs1:certificationInfo,
gs1:epil,
gs1:instructions,
gs1:quickStartGuide,
gs1:recipeInfo,
gs1:safetyInfo,
gs1:traceability,
gs1:whatsInTheBox
languages
string<bcp47-language-tag>[] | null

At least one BCP 47 language tag.

BCP 47 language tag with a real ISO 639-1 primary subtag (e.g. en, es-MX, fr-CA). Matching against a document's stored languages falls back to the primary subtag, so es-MX matches a document filed under plain es.

Pattern: ^(?:aa|ab|ae|af|ak|am|an|ar|as|av|ay|az|ba|be|bg|bi|bm|bn|bo|br|bs|ca|ce|ch|co|cr|cs|cu|cv|cy|da|de|dv|dz|ee|el|en|eo|es|et|eu|fa|ff|fi|fj|fo|fr|fy|ga|gd|gl|gn|gu|gv|ha|he|hi|ho|hr|ht|hu|hy|hz|ia|id|ie|ig|ii|ik|io|is|it|iu|ja|jv|ka|kg|ki|kj|kk|kl|km|kn|ko|kr|ks|ku|kv|kw|ky|la|lb|lg|li|ln|lo|lt|lu|lv|mg|mh|mi|mk|ml|mn|mr|ms|mt|my|na|nb|nd|ne|ng|nl|nn|no|nr|nv|ny|oc|oj|om|or|os|pa|pi|pl|ps|pt|qu|rm|rn|ro|ru|rw|sa|sc|sd|se|sg|sh|si|sk|sl|sm|sn|so|sq|sr|ss|st|su|sv|sw|ta|te|tg|th|ti|tk|tl|tn|to|tr|ts|tt|tw|ty|ug|uk|ur|uz|ve|vi|vo|wa|wo|xh|yi|yo|za|zh|zu)(-[A-Z][a-z]{3})?(-([A-Z]{2}|\d{3}))?(-([0-9A-Za-z]{5,8}|\d[0-9A-Za-z]{3}))*$
markets
enum<string>[] | null

ISO 3166-1 alpha-2 codes. Empty means all markets.

ISO 3166-1 alpha-2 market code (e.g. US, CA). Unlike the filter on the list endpoint (which accepts any 2-letter code, matching nothing for an unassigned one), this is data a brand is asserting about the document, so it is checked against the real assigned set — same rule as apps.core.api.types.CountryCode, but published as an explicit enum here (rather than a loose pattern) so the contract-fuzz suite cannot generate a schema-compliant-but-unassigned code and get a 422 for it (C-4684 contract ratchet; the underlying CountryCode/pattern mismatch is pre-existing, wider debt — see the baselined POST /account/api/v1/organizations — not something this ticket reopens).

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
labels
string[] | null

At most 10 brand-owned tags, each at most 40 characters.

Maximum array length: 10
Required string length: 1 - 40
title
string | null

Document title.

Maximum string length: 255
description
string | null

Free-text description.

is_pinned
boolean | null

At most one pinned document per product.

sort_order
integer | null

Tiebreaker within a purpose group; lower sorts first.

Required range: x >= 0
is_active
boolean | null

Set false to soft-hide the document from every public surface (the page, the Catalog API, the resolver linkset) without deleting it; set true to restore it.

Response

OK

A single document, as returned by the public Catalog API.

id
string<shortuuid>
required

Document identifier.

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

GS1 link type CURIE describing what this document is, e.g. gs1:instructions.

title
string
required

Document title.

url
string
required

Resolvable public URL for this document — never a signed or expiring one. For an uploaded file this is Closient's own download-redirect endpoint (permanent; it re-signs on every hit). For a brand-supplied link this is that link verbatim.

media_type
string
required

Full IANA media type, e.g. application/pdf.

format
enum<string>
required

Presentation bucket derived from media_type.

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

BCP 47 language tags this document is available in.

markets
string[]
required

ISO 3166-1 alpha-2 codes. Empty means all markets.

labels
string[]
required

Brand-owned free-text tags, normalized to lowercase.

is_pinned
boolean
required

Featured above the rest of the section.

sort_order
integer
required

Tiebreaker within a purpose group; lower sorts first.

is_active
boolean
required

Inactive documents are excluded from every public surface.

description
string
default:""

Free-text description.

file_size_bytes
integer | null

Size of an uploaded file. Null for a link-only document.