Skip to main content
PUT
Update Product

Headers

authorization
string | null
X-API-Key
string | null
X-Stella-Merchant-Id
string | null

Path Parameters

product_id
string<uuid>
required

Body

application/json

Schema for updating a product.

name
string | null
Maximum string length: 255
slug
string | null
Maximum string length: 255
description
string | null
vendor
string | null
Maximum string length: 255
product_type
string | null
Maximum string length: 255
tags
string[] | null
price
Required range: x >= 0
compare_at_price
Required range: x >= 0
cost_per_item
Required range: x >= 0
currency
string | null
Maximum string length: 3
images
ImageCreate · object[] | null
options
ProductOptionCreate · object[] | null
track_inventory
boolean | null
status
string | null
Pattern: ^(active|draft|archived)$

Response

Successful Response

Schema for product in responses.

id
string<uuid>
required
merchant_id
string<uuid>
required
name
string
required
slug
string | null
required
description
string | null
required
vendor
string | null
required
product_type
string | null
required
tags
string[] | null
required
price
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
compare_at_price
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
cost_per_item
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required
images
Images · object[]
required
has_variants
boolean
required
options
Options · object[]
required
variants
VariantResponse · object[]
required
track_inventory
boolean
required
total_inventory
integer
required
in_stock
boolean
required
status
string
required
published_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required