Update Product

POST

vendor

products

{id}

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Acme T-Shirt v2", "description": "Softer fabric."}'

const { product_change } = await client.vendor.products.$id.mutate({
  $id: "prod_01HXYZ",
  title: "Acme T-Shirt v2",
  description: "Softer fabric.",
})

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "created_by": "sel_01HXYZ",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "UPDATE",
        "details": { "title": "Acme T-Shirt v2" },
        "applied": false
      }
    ]
  }
}

Does not modify the product directly. It stages a pending change request that an operator confirms or declines.

The endpoint responds with 202 Accepted and a product_change record, not the updated product. Use Preview Product Change to inspect the pending change and Cancel Product Change to withdraw it.

Path parameters

string

required

The product’s ID.

Body parameters

string

The product’s title.

string

The product’s subtitle.

string

The product’s description.

boolean

Whether discounts can apply to the product.

boolean

Whether the product is a gift card.

object[]

Show properties

string

Existing image ID to keep.

string

required

Image URL.

string

URL of the product’s thumbnail image.

string

The product’s URL handle.

string

ID of the product in an external system.

string

ID of the product type.

string

ID of the collection the product belongs to.

object[]

Show properties

string

required

Category ID.

object[]

Show properties

string

required

Tag ID.

object[]

Show properties

string

required

Option title.

string[]

required

Allowed option values.

object[]

Variant updates staged with the change.

Show properties

string

Existing variant ID to update.

string

Variant title.

string

Variant SKU.

string

EAN barcode.

string

UPC barcode.

string

ISBN code.

string

Amazon ASIN.

string

GTIN code.

string

Generic barcode.

string

Harmonized System code.

string

Manufacturer ID code.

string

Variant thumbnail URL.

number

Sort rank of the variant.

number

Weight of the variant.

number

Length of the variant.

number

Height of the variant.

number

Width of the variant.

string

Country of origin.

string

Material of the variant.

object

Custom key-value pairs.

object

Option title to value mapping.

number

Weight of the product.

number

Length of the product.

number

Height of the product.

number

Width of the product.

string

Harmonized System code.

string

Manufacturer ID code.

string

Country of origin.

string

Material of the product.

object

Custom key-value pairs.

object

Extra data passed to workflow hooks.

Response

object

Show properties

string

The change request’s ID.

string

ID of the product the change targets.

string

One of pending, confirmed, declined, canceled.

string

ID of the seller that staged the change.

object[]

Staged operations, each with id, action (e.g. UPDATE), details, ordering, and applied.

string

Internal note attached to the change.

string

Note from the operator, e.g. a revision request.

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Acme T-Shirt v2", "description": "Softer fabric."}'

const { product_change } = await client.vendor.products.$id.mutate({
  $id: "prod_01HXYZ",
  title: "Acme T-Shirt v2",
  description: "Softer fabric.",
})

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "created_by": "sel_01HXYZ",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "UPDATE",
        "details": { "title": "Acme T-Shirt v2" },
        "applied": false
      }
    ]
  }
}

curl -X POST 'http://localhost:9000/vendor/products/prod_01HXYZ' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>' \
  -H 'Content-Type: application/json' \
  -d '{"title": "Acme T-Shirt v2", "description": "Softer fabric."}'

const { product_change } = await client.vendor.products.$id.mutate({
  $id: "prod_01HXYZ",
  title: "Acme T-Shirt v2",
  description: "Softer fabric.",
})

{
  "product_change": {
    "id": "prodch_01HXYZ",
    "product_id": "prod_01HXYZ",
    "status": "pending",
    "created_by": "sel_01HXYZ",
    "actions": [
      {
        "id": "prodchact_01HXYZ",
        "action": "UPDATE",
        "details": { "title": "Acme T-Shirt v2" },
        "applied": false
      }
    ]
  }
}

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