Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json
name
string
required
url
string
required
defaultVariantId
string<uuid> | null
description
string | null
handle
string | null
metadata
object | null
primarySyncSource
object | null
productMediaAssets
object[] | null
variantOptionIds
string<uuid>[] | null
variants
object[] | null

Response

Product created or updated successfully

archived
boolean
required
createdAt
string<date-time>
required
createdBy
string
required
id
string<uuid>
required
name
string
required
Minimum string length: 1
organizationId
string<uuid>
required
url
string<uri>
required
defaultVariantId
string<uuid> | null
description
string | null
handle
string | null
metadata
object | null
primaryExternalId
string | null
primaryLastSyncedAt
string<date-time> | null
primarySourceVendor
string | null
primarySyncSource
object | null
primarySyncSourceId
string | null
productMediaAssets
object[] | null
updatedAt
string<date-time> | null
updatedBy
string | null
variants
object[] | null