Skip to main content
POST
Attach a product image from a vendor-supplied URL

Authorizations

X-API-Key
string
header
required

Path Parameters

gtin
string
required

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

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

Body

application/json

A vendor-vetted URL to fetch and attach as a product image.

source_url
string
required

HTTPS URL a human obtained directly from the retailer for this specific product (e.g. a DAM export link), not a URL discovered by crawling. Downloaded synchronously, capped at 20 MB, sniffed from magic bytes, and rejected if the format or dimensions fall outside what the catalog accepts.

Maximum string length: 2000
source_retailer
enum<string>
required

Which retailer supplied this URL, for provenance and dedup attribution.

Available options:
ulta_catalog,
sephora_catalog

Response

OK

Result of a vendor-URL image ingestion attempt.

status
string
required

created, deduped, or skipped_existing (this URL was already ingested).

image_id
string | null

The ProductImage id, when one exists after this call.