Skip to main content
PATCH
Update a product

Authorizations

Authorization
string
header
required

An organization's API key, sent on every call as Authorization: Bearer <key>. A person of the organization creates it in the app, in Settings › API and connections › API keys.

Path Parameters

orgId
string<uuid>
required
productId
string<uuid>
required

Body

application/json
expectedVersion
integer
required
Required range: x >= 1
title
string
Required string length: 1 - 300
slug
string
Required string length: 1 - 200
condition
enum<string>
Available options:
new,
open_box,
new_with_defects,
used,
used_like_new,
used_very_good,
used_good,
used_acceptable,
refurbished,
collectible_like_new,
collectible_very_good,
collectible_good,
collectible_acceptable,
for_parts_or_not_working
productType
string | null
Maximum string length: 100
descriptionHtml
string | null

The product's description in HTML, which keeps paragraphs, headings, lists and task lists, quotes, code blocks, images, tables, rules, line breaks, links, bold, italic, underline, strikethrough, subscript, superscript, text colour, highlight, alignment, and YouTube, Vimeo or video embeds. Anything else, such as a script, an event attribute or another site's frame, is removed and its text kept; a description left with nothing is saved as none.

metaTitle
string | null
Maximum string length: 200
metaDescription
string | null
Maximum string length: 300
options
object[]
variants
object[]

Response

OK

id
string<uuid>
required
title
string
required
slug
string
required
status
enum<string>
required
Available options:
draft,
active,
unlisted,
archived
condition
enum<string>
required
Available options:
new,
open_box,
new_with_defects,
used,
used_like_new,
used_very_good,
used_good,
used_acceptable,
refurbished,
collectible_like_new,
collectible_very_good,
collectible_good,
collectible_acceptable,
for_parts_or_not_working
productType
string | null
required
descriptionHtml
string | null
required

The product's description in HTML, as it was saved; null when it has none.

metaTitle
string | null
required
metaDescription
string | null
required
version
integer
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
createdBy
object
required
updatedBy
object
required
options
object[]
required
variants
object[]
required
warnings
object[]
required