Update Product

POST

admin

products

{id}

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Linen Shirt v2", "status": "published"}'

const { product } = await client.admin.products.$id.mutate({
  $id: "prod_01HXYZABCDEF",
  title: "Linen Shirt v2",
  status: "published",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt v2",
    "handle": "linen-shirt",
    "status": "published",
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

Updates the product’s details; only the provided fields are changed.

Path parameters

string

required

The product’s ID.

Body parameters

string

Product title.

string

Product subtitle.

string

Product description.

string

Unique URL-safe handle.

string

One of draft, proposed, published, rejected.

boolean

Whether the product is a gift card.

boolean

Whether discounts can apply to the product.

string

URL of the product thumbnail.

object[]

Product images; replaces the existing set.

Show properties

string

Existing image ID to keep.

string

required

Image URL.

string

ID of the product in an external system.

string

ID of the product type.

string

ID of the collection to assign the product to.

object[]

Categories to assign; replaces the existing set.

Show properties

string

required

Category ID.

object[]

Tags to assign; replaces the existing set.

Show properties

string

required

Tag ID.

object[]

Product options; replaces the existing set.

Show properties

string

required

Option title.

string[]

required

Possible option values.

object[]

Variants to upsert; include id to update an existing variant.

Show properties

string

Existing variant ID.

string

Variant title.

string

Variant SKU.

string

Variant EAN.

string

Variant UPC.

string

Variant ISBN.

string

Variant ASIN.

string

Variant GTIN.

string

Variant barcode.

string

Harmonized System code.

string

Manufacturer identification code.

string

URL of the variant thumbnail.

number

Sort rank of the variant.

number

Variant weight.

number

Variant length.

number

Variant height.

number

Variant width.

string

Country of origin.

string

Variant material.

object[]

Prices with id, currency_code, amount, min_quantity, max_quantity, and rules.

object

Map of option title to option value.

object

Custom key-value data.

number

Product weight.

number

Product length.

number

Product height.

number

Product width.

string

Harmonized System code.

string

Manufacturer identification code.

string

Country of origin.

string

Product material.

object

Custom key-value data.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The product’s ID.

string

Product title.

string

One of draft, proposed, published, rejected.

object[]

Product variants.

object[]

Attribute values selected on the product.

object[]

Product-scoped (inline) attributes.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Linen Shirt v2", "status": "published"}'

const { product } = await client.admin.products.$id.mutate({
  $id: "prod_01HXYZABCDEF",
  title: "Linen Shirt v2",
  status: "published",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt v2",
    "handle": "linen-shirt",
    "status": "published",
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Linen Shirt v2", "status": "published"}'

const { product } = await client.admin.products.$id.mutate({
  $id: "prod_01HXYZABCDEF",
  title: "Linen Shirt v2",
  status: "published",
})

{
  "product": {
    "id": "prod_01HXYZABCDEF",
    "title": "Linen Shirt v2",
    "handle": "linen-shirt",
    "status": "published",
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Path parameters

Body parameters

Response

​Path parameters

​Body parameters

​Response

Path parameters

Body parameters

Response