Read Product Change
Read a product change
One product change. A user's decision shows as pending until it can no longer
be undone (35 seconds).
HTTPBearerAuthorizationBearer <token>change_id*Change IduuidSuccessful Response
application/json- response
A product change as an MCP client sees it. A decision by a user stays hidden
(pending, no decision fields) until it can no longer be undone.
apply_error is set for failed only.
id*Iduuidstatus*ProductChangeStatus"pending""approved""declined""applied""failed""stale""withdrawn"internal_product_id*Internal Product Iduuidstore_id*Store Idproduct_store_link_id*Product Store Link Iduuidchange_types*array<>patch*The change a client proposes, on the fields of InternalProductUpdateRequest:
null leaves a field alone, a list replaces the whole list. Metafields are not in
the product document, so they are set or deleted one namespace.key at a time.
delete removes the product and stands alone.
diff*product_change.diff: old and new value of every field the change touches,
computed against base_revision_number; variants and images per element.
base_revision_number*Base Revision Numberreason*string|nullproposer*api_key: the key's Clerk id and name; user: the signed-in user.
amended_at*|nullamend_count*Amend Countrisk_level*|nullrisk_raised_from*|nullrisk_raised_at*|nullevaluation*product_change.evaluation and the rule result of pchange.api.evaluate.
risk_level is null for auto_approve; order_data_missing marks an
auto_approve lowered to manual_low because the store has no order data.
decided_by_kind*|nulldecided_at*|nulldecline_feedback*string|nullapplied_at*|nullapply_error*string|nullcreated_at*Created Atdate-timeupdated_at*Updated Atdate-timecurl -X GET 'https://app.copyhero.app/api/v1/product-changes/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "pending", "internal_product_id": "17d65d0a-2bba-46da-af25-e6db2fc23598", "store_id": 0, "product_store_link_id": "f7d0a9a7-e8e4-4f5e-9e00-7ea8f5e3b61b", "change_types": [ "price" ], "patch": { "title": "string", "body_html": "string", "vendor": "string", "product_type": "string", "tags": [ "string" ], "seo_title": "string", "seo_description": "string", "options": [ { "name": "string", "position": 0, "values": [ { "value": "string", "position": 0 } ] } ], "variants": [ { "sku": "string", "price": "string", "compare_at_price": "string", "option_values": [ { "name": "string", "value": "string" } ], "image_src": "string", "metafields": [ { "namespace": "string", "key": "string", "type": "string", "value": "string" } ] } ], "images": [ { "src": "string", "position": 0, "alt_text": "string" } ], "metafields": [ { "namespace": "string", "key": "string", "type": "string", "value": "string" } ], "status": "active", "delete": false }, "diff": { "fields": [ { "field": "title", "old": null, "new": null } ], "variants": [ { "ref": { "key": "string", "sku": "string", "option_values": [ { "name": "string", "value": "string" } ], "create": true }, "old": { "sku": "string", "price": "string", "compare_at_price": "string", "option_values": [ { "name": "string", "value": "string" } ], "image_src": "string", "metafields": [ { "namespace": "string", "key": "string", "type": "string", "value": "string" } ] }, "new": { "sku": "string", "price": "string", "compare_at_price": "string", "option_values": [ { "name": "string", "value": "string" } ], "image_src": "string", "metafields": [ { "namespace": "string", "key": "string", "type": "string", "value": "string" } ] } } ], "images": [ { "ref": { "key": "string", "shopify_id": "string", "url": "string", "create": true }, "old": { "src": "string", "position": 0, "alt_text": "string" }, "new": { "src": "string", "position": 0, "alt_text": "string" } } ] }, "base_revision_number": 0, "reason": "string", "proposer": { "kind": "api_key", "api_key_id": "string", "api_key_name": "string", "user_id": 0 }, "amended_at": "2019-08-24T14:15:22Z", "amend_count": 0, "risk_level": "low", "risk_raised_from": "low", "risk_raised_at": "2019-08-24T14:15:22Z", "evaluation": { "outcome": "auto_approve", "risk_level": "low", "order_data_missing": true, "change_types": [ { "change_type": "price", "outcome": "auto_approve", "winner_rule_id": "a0d63d6e-eec1-49e2-b3f1-596e5cd260a6", "rules": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "outcome": "auto_approve", "change_types": [ "price" ], "conditions": { "v": 1, "all": [ { "field": "string", "op": "string", "value": null } ] } } ] } ] }, "decided_by_kind": "user", "decided_at": "2019-08-24T14:15:22Z", "decline_feedback": "string", "applied_at": "2019-08-24T14:15:22Z", "apply_error": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}Preflight Product Change POST
Preview a product change Dry run of proposing a product change: the diff, change types and what the approval rules would decide. Nothing is stored.
Withdraw Product Change POST
Withdraw a pending product change Withdraw a pending product change; 409 when it is no longer pending. Any API key of the organization may withdraw.