CRUD: Update a product

Updates a Product object.

Request
path Parameters
id
required
string

Object id

query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Entity-Ids
string

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-Ids
string

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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Track-Id
string <= 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 (').

X-Zuora-WSDL-Version
string
Default: 79

Zuora WSDL version number.

Request Body schema: application/json
required
AllowFeatureChanges
boolean

Controls whether to allow your users to add or remove features while creating or amending a subscription.

Values: true, false (default)

Category
string <= 100 characters

Category of the product. Used by Zuora Quotes Guided Product Selector.

Values:

  • Base Products
  • Add On Services
  • Miscellaneous Products
Description
string <= 500 characters

A description of the product.

EffectiveEndDate
string <date>

The date when the product expires and can't be subscribed to anymore, in yyyy-mm-dd format.

EffectiveStartDate
string <date>

The date when the product becomes available and can be subscribed to, in yyyy-mm-dd format.

Name
string <= 100 characters

The name of the product. This information is displayed in the product catalog pages in the web-based UI.

ProductNumber
string <= 100 characters

The natural key of the product.

For existing Product objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact Zuora Global Support.

Note: This field is only available if you set the X-Zuora-WSDL-Version request header to 133 or later.

SKU
string <= 50 characters

The unique SKU for the product.

IntegrationId__NS
string <= 255 characters

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NS
string <= 255 characters

Status of the product's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

ItemType__NS
string

Type of item that is created in NetSuite for the product. Only available if you have installed the Zuora Connector for NetSuite.

Enum: "Inventory" "Non Inventory" "Service"
SyncDate__NS
string <= 255 characters

Date when the product was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

property name*
additional property
any

Custom fields of the Product object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Responses
200
401
put/v1/object/product/{id}
Request samples
application/json
{
  • "Description": "Create product via API_new",
  • "EffectiveEndDate": "2066-10-20",
  • "EffectiveStartDate": "1966-10-20",
  • "Id": "2c93808457d787030157e02e7be22210",
  • "Name": "P_1476934925293_new",
  • "SKU": "API-SKU1476934925293"
}
Response samples
application/json
{
  • "Id": "2c93808457d787030157e02e7be22210",
  • "Success": true
}