Skip to main content

Commerce Catalog


Commerce Catalog

The Commerce Catalog feature allows you to add marketing and internationalization information to the product, product rate plan, and product rate plan charge details configured in the product catalog in Zuora Billing. 

Commerce Catalog overview

The following diagram outlines how Commerce Catalog is used with Zuora and Subscriber Portal:

Catalog overview

  1. Zuora’s Product Catalog can be considered as a system of record for base product configurations. You can configure your products in the Product Catalog of Zuora, and then push the data to the Subscriber Portal, Salesforce, or other downstream applications. You must ensure that the pricing and custom field details are configured at the Product, Product Rate Plan, Product Rate Plan Charge levels. 
  2. Commerce Catalog APIs are used to pull product catalog from Zuora and synchronize into the app itself. Upon retrieval of the information, it flattens the Product, Product Rate Plan,  Product Rate Plan Charge, and Product Rate Plan Charge Tier details into a single Rate Plan object. This does not remove the relationship among these objects, but flattens it to a single structure to simplify the selection. Custom fields created in Zuora are extracted and work in two ways:
    • Once a custom field is synchronized into Commerce Catalog, you can assign the custom field as an attribute to a product. It allows you to configure that attribute during the product configuration. For example, if you create a custom field called color as a select list and give it values orange and blue, after synchronizing into Commerce Catalog, you can associate this custom field to one or more rate plans in Commerce Catalog. When end-users view the product details in the Subscriber Portal, the custom field is displayed and they need to select a color for the product before adding the product to the Cart. Note that custom fields marked as required in Zuora will be required during configuration.
    • Creating custom fields in Zuora and assigning values to products enable end subscribers to use filters when viewing the products displayed in the Subscriber Portal. For example, a custom field called color. and for Rate Plan 1 you select orange for color, and for Rate Plan 2 you select blue. When end subscribers view products in the Subscriber Portal UI, a filter is displayed to allow them to select blue or orange, and return all products or rate plans that match the selected color.
  3. The Commerce Catalog APIs can be used by Subscriber Portal or other downstream systems to retrieve configured details. All details, including custom fields and product details, are available to be retrieved through API requests. Retrieved data is then displayed to end-users for selection and configuration when creating or modifying subscriptions.


The Shopping feature is included in the Commerce Catalog app. With the Shopping feature, your customers or prospects can:

  • View all available products that are synchronized from Commerce Catalog.
  • Add products to a cart.
  • Create an account.
  • Create or update their subscriptions.

To give you an intuitive understanding of this feature, a Subscriber Portal UI mockup with the Shopping feature enabled is provided below:

Portal with the Shopping feature

Get Started with Commerce Catalog


Before using Commerce Catalog, ensure you meet the following requirements:

  • You have purchased the following apps:
    • Commerce Catalog
    • Subscriber Portal, if you want to use with the Subscriber Portal feature.
  • You have the administrative rights for your Zuora tenant.
  • You have created products in Product Catalog.

You need to purchase the app in the Zuora Marketplace before you can install it. The name for the app in the marketplace is Customer Catalog. See Purchase an App to learn about how to purchase an app. 

Follow the instructions in Install an App to install the app. Specific to this app:

  • Build Name - Select Production - US.
  • Source and Target - Authentication details for your Zuora tenant. You must select or create a Zuora login that uses basic authentication. This app does not support OAuth.


See Configure Commerce Catalog for more information.

Link Commerce Catalog to Subscriber Portal

See Link Commerce Catalog to Subscriber Portal for more information.