Products
Preview Product Changes
Retrieve the pending change set for a product.
GET
/
admin
/
products
/
{id}
/
preview
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/preview' \
-H 'Authorization: Bearer <token>'
const { product_change } = await client.admin.products.$id.preview.query({
$id: "prod_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "pending",
"internal_note": null,
"external_note": null,
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
],
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
Returns the product’s pending change request with its individual change actions, or
null if no change is pending.
The response contains the pending
product_change record and its actions (the raw edits awaiting review), not a merged product payload.Path parameters
string
required
The product’s ID.
Response
object | null
Show properties
Show properties
string
The product change’s ID.
string
ID of the product the change applies to.
string
Always
pending for this endpoint.string
Note visible to operators only.
string
Note visible to the vendor.
string
ID of the actor who created the change.
object[]
string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/preview' \
-H 'Authorization: Bearer <token>'
const { product_change } = await client.admin.products.$id.preview.query({
$id: "prod_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "pending",
"internal_note": null,
"external_note": null,
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
],
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}
⌘I
curl 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/preview' \
-H 'Authorization: Bearer <token>'
const { product_change } = await client.admin.products.$id.preview.query({
$id: "prod_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "pending",
"internal_note": null,
"external_note": null,
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
],
"created_at": "2026-06-01T10:00:00.000Z",
"updated_at": "2026-06-01T10:00:00.000Z"
}
}