Update a product

Change some fields of a product (partial update).

Endpoint

PATCH
/products/:id

Body parameters

Any writable field of the product object: name, description, type, status, price, system_currency_id, sku, product_category_id, parent_id, is_variant, track_inventory, allow_backorder, stock_quantity, billing_type, billing_interval, billing_interval_count, meta_data, is_embeddable, custom_fields_by_key. Only the fields you send change. organization_id cannot be changed.

Request

Response

Returns the updated product.

json

Notes

  • Billing cadence: every PATCH normalizes billing_type. A request without billing_type sets it to one_time and clears billing_interval and billing_interval_count. When you update a recurring product, always send billing_type, billing_interval and billing_interval_count with the other fields.
  • Custom fields: send custom_fields_by_key with field keys from GET /custom-fields?entity_type=product. Setting a key to null clears it. The API rebuilds custom_fields_by_name and custom_fields_meta_data.
  • AI search: is_embeddable: true (re)indexes the product for AI assistant product search, false removes it. Changing custom fields of an embeddable product re-indexes it.

Errors

StatusMessage / cause
400 Bad RequestA product with SKU '…' already exists in your organization. Please use a different SKU.
404 Not FoundNo product with this ID in your organization.

Report an issue with this documentation

Please log in to report issues with our documentation.