Sign in
Products

CRUD: Retrieve a product

Retrieve a specific product.

get/v1/object/product/{id}

Path parameters

idstring required

Object id

Query parameters

fieldsstring

Object fields to return

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

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 (').

X-Zuora-WSDL-Versionstring

Zuora WSDL version number.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

AllowFeatureChangesboolean

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

Values: true, false (default)

Categorystring

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

Values:

  • Base Products
  • Add On Services
  • Miscellaneous Products
CreatedByIdstring

The automatically generated ID of the Zuora user who created the Product object.

CreatedDatestring date-time

The date when the Product object was created.

Descriptionstring

A description of the product.

EffectiveEndDatestring date

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

EffectiveStartDatestring date

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

Idstring

Object identifier.

Namestring

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

SKUstring

The unique SKU for the product.

UpdatedByIdstring

The ID of the last user to update the object.

UpdatedDatestring date-time

The date when the object was last updated.

IntegrationId__NSstring

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

IntegrationStatus__NSstring

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

ItemType__NS'Inventory' | 'Non Inventory' | 'Service'

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

SyncDate__NSstring

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

Changes