Skip to main content
PATCH
Update Product

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

productId
string
required

Body

application/json

Partial product object. Only provided fields will be updated.

name
string
Maximum string length: 400
description
string
sku
string
Maximum string length: 200
brand
string
Maximum string length: 160
price
number
Required range: x >= 0
currency
string
Maximum string length: 3
weight
number
Required range: x >= 0
dimensions
object
inventory
object
images
string<uri>[]

Array of HTTP(S) image URL strings only. Image objects and delimited strings are not accepted. Each entry is a complete URL, including commas in paths or query strings. Images follow array order.

Maximum string length: 2048
Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://
highlights
string[]
tags
string[]
marketplaces
object
status
enum<string>
Available options:
draft,
active,
archived

Response

Product updated successfully

success
boolean
productId
string
product
object