Sign in
Commerce

Update a product

Updates an existing product in the Product Catalog. Use this API to update core product fields such as name, description, category, effective dates, and custom fields.

put/commerce/products

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request body

idstring required

Unique identifier of the product to update.

namestring

Product name.

descriptionstring

Product description.

categorystring

Product category label, for example, base, add-on.

custom_fieldsobject

Custom fields to set on the product. Keys must match configured custom field API names. Values may be strings, numbers, booleans, or arrays depending on field definition.

startDatestring date

Product effective start date (UTC, YYYY-MM-DD).

endDatestring date

Product effective end date (UTC, YYYY-MM-DD).

Example request

{
  "id": "8ad088009840d1c2019855e15c993f2f",
  "name": "Software Service",
  "description": "Software service - basic edition",
  "category": "base",
  "custom_fields": {
    "HelloBay__c": "Updated value",
    "Tags__c": [
      "AI Powered",
      "Internet Required"
    ]
  },
  "startDate": "2025-05-11",
  "endDate": "2050-12-10"
}

Response

OK

idstring

Unique identifier of the product.

namestring

Product name.

descriptionstring

Product description.

categorystring

Product category label.

productNumberstring

Product number in the catalog.

skustring

Product SKU.

startDatestring date

Product effective start date (UTC, YYYY-MM-DD).

endDatestring date

Product effective end date (UTC, YYYY-MM-DD).

statestring

Current product state.

allowFeatureChangesboolean

Whether features on this product can be changed.

featuresobject[]

Product features.

legacyFeaturesobject[]

Legacy features associated with this product.

contextFiltersobject[]

Context filters applied to the product.

customFieldsobject

Custom fields on the product.

customObjectsobject nullable

Custom objects linked to this product.

netsuiteobject nullable

Netsuite integration attributes.

organizationLabelsstring[]

Organization labels for the product.

productRatePlansobject[]

Rate plans (PRPs) defined under the product.

createdBystring

ID of the user who created the product.

createdTimestring date-time

Timestamp when the product was created.

updatedBystring

ID of the user who last updated the product.

updatedTimestring date-time

Timestamp when the product was last updated.

Example response

{
  "id": "00c86e3a0595442c88ed9ef8474b10a7",
  "name": "Amadeus",
  "description": "Software service - basic edition",
  "category": "base",
  "productNumber": "PC-00000095",
  "sku": "SKU-00000122",
  "startDate": "2024-01-08",
  "endDate": "2050-12-31",
  "state": "product_active",
  "createdBy": "8a90a2fd8030ea2e018032b11d3a3f06",
  "createdTime": "2025-08-06T18:11:35.000-07:00",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedTime": "2025-10-23T04:55:54.000-07:00"
}

Changes