Update a product

Updates an existing product. Send the product in the same shape GET /product/{product}.json returns, including its id. Server-set fields like created and updated are ignored. The item list you send is the final set (items you leave out are removed), and view is adjusted from that count as below.

Smooth POS adjusts view from the live item count: exactly one item → Single Product (even if you sent Dimensioned Product); a Single Product with two or more items → Dimensioned Product. Gift Card and Sale Operation products keep their view.

active is only changed when you send it; leave it out to keep the current value.

Required permission (any one of these):

GroupPermission
ProductsView item cost history
ProductsChange item costs (includes view)
ProductsCreate, edit and delete products (includes view)
Body Params
string
required
integer
required

Unique ID. Set by Smooth POS.

images
object
items
array of objects

The product's items (variants).

items
metadata
object
string
required
option_names
object
required

Names of the options your items vary by, e.g. COLOR, SIZE.

number
number
string
required

Style code.

tags
array of strings

Tags attached to the product.

tags
string
required

The product's type.

string
required

The product's vendor.

boolean

Whether the product is active. Leave it out to leave the current value unchanged. Used for filtering lists and exports.

string
required

How the product is shown. One of Dimensioned Product, Single Product, Gift Card or Sale Operation (case-insensitive on write; unknown values are stored as Dimensioned Product). Smooth POS adjusts view from the live item count: exactly one item → Single Product; a Single Product with two or more items → Dimensioned Product. Gift Card and Sale Operation products are never changed.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json