Skip to main content
POST
Import Json

Headers

authorization
string | null
X-Organization-ID
string | null

Cookies

stytch_session
string | null

Body

application/json

Request model for JSON product import.

products
JsonImportProduct · object[]
required

List of products to import

batch_size
integer
default:25

Batch size for processing

Required range: 1 <= x <= 50
enrich_product
boolean
default:true

Run AI enrichment

ignore_manual_edits
boolean
default:false

When True, do NOT preserve properties flagged properties_metadata.{key}.manual_edit — the incoming values win. Default False keeps the manual-edit protection. Intended for a deliberate authoritative resync where the source of truth is external; protect specific fields by omitting them from the payload instead.

merge_only_provided
boolean
default:false

When True, overlay ONLY the provided properties onto each existing product's latest version, preserving all other fields. Ignored when enrichment is requested.

scrape_brand_site
boolean
default:true

Scrape brand website during enrichment

search_lakehouse
boolean
default:true

Search product lakehouse for existing data

validate
boolean
default:false

Validate against ProductType

Response

Successful Response

Response model for batch product creation.

created
integer
required

Number successfully created

failed
integer
required

Number that failed

total
integer
required

Total products submitted

errors
Errors · object[]

List of errors

job_id
string | null

Job ID for tracking batch progress

skipped
integer
default:0

Number unchanged (no new version created)

variants_created
integer
default:0

Number of variants created/updated from variant rows