Skip to navigation
CommerceCommerce

Update a product

View as Markdown
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.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Accept-EncodingstringOptional

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-EncodingstringOptional

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-IdstringOptional<=64 characters

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-IdsstringOptional

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-IdsstringOptional

Comma separated IDs. If you have Zuora Multi-Org 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

This endpoint expects an object.
idstringRequired
Unique identifier of the product to update.
namestringOptional
Product name.
descriptionstringOptional
Product description.
categorystringOptional

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

custom_fieldsmap from strings to anyOptional
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.
startDatedateOptional

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

endDatedateOptional

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

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

OK
idstringOptional
Unique identifier of the product.
namestringOptional
Product name.
descriptionstringOptional
Product description.
categorystringOptional
Product category label.
productNumberstringOptional
Product number in the catalog.
skustringOptional
Product SKU.
startDatedateOptional

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

endDatedateOptional

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

statestringOptional
Current product state.
allowFeatureChangesbooleanOptional
Whether features on this product can be changed.
featureslist of maps from strings to anyOptional
Product features.
legacyFeatureslist of maps from strings to anyOptional
Legacy features associated with this product.
contextFilterslist of maps from strings to anyOptional
Context filters applied to the product.
customFieldsmap from strings to anyOptional
Custom fields on the product.
customObjectsmap from strings to any or nullOptional
Custom objects linked to this product.
netsuitemap from strings to any or nullOptional
Netsuite integration attributes.
organizationLabelslist of stringsOptional
Organization labels for the product.
productRatePlanslist of maps from strings to anyOptional

Rate plans (PRPs) defined under the product.

createdBystringOptional
ID of the user who created the product.
createdTimedatetimeOptional
Timestamp when the product was created.
updatedBystringOptional
ID of the user who last updated the product.
updatedTimedatetimeOptional
Timestamp when the product was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error