Skip to main content
PUT
Update a product

Authorizations

x-client-secret
string
header
required

Your secret API key. Keep this secure and never expose it in client-side code.

Path Parameters

id
string
required

Product ID

Body

multipart/form-data
name
string

Product name as it will appear to customers. Should be clear and descriptive.

Required string length: 1 - 200
Example:

"Premium Software License"

description
string

Detailed description of the product. Supports markdown formatting for rich text display.

Maximum string length: 2000
Example:

"Annual license for our premium software suite with advanced features, priority support, and regular updates."

price
number

Product price in the specified currency. Must be greater than 0.

Required range: x >= 0.01
Example:

299.99

currency
enum<string>
default:USD

Currency code for the price. Defaults to USD if not specified.

Available options:
USD,
EUR,
GBP,
CAD,
AUD,
JPY
Example:

"USD"

type
string

Product type

Example:

"DIGITAL"

weight
number

Weight of the product

unit
string

Unit of measurement

quantity
number

Quantity available

stockCount
number

Stock count

status
string

Product status

Example:

"ACTIVE"

productType
string

Product type

Example:

"PRODUCT"

images
string[]

Array of image URLs

Response

The product has been successfully updated.