Skip to main content

Import the WSDL

Zuora

Import the WSDL

This article describes the process of downloading a copy of Zuora WSDL and uploading it to Salesforce.

The Zuora WSDL is used by Order Builder and Invoice PDFs.

Download the Zuora WSDL

Before you download the Zuora WSDL, check your permissions and the version of the WSDL:

  • The WSDL you download is tailored to match the permissions of your tenant and user.

If you do not have permission for a feature, it may not be included in the WSDL. So if you have different permissions on the API Sandbox than on the Production environment, for instance, use the site where you have the desired features enabled.

  • Use a current or recent copy of the Zuora WSDL.

Zuora WSDLs are designed to be backward-compatible. When upgrading to the latest Zuora Connector for Salesforce CRM, you should typically use the latest WSDL with it.

Download a copy of the Zuora WSDL as described in The Zuora WSDL​​

After you download Zuora WSDL, do not modify the WSDL file before you upload it to Salesforce.

Set Up a Schema

Use the zSchema Setup configuration page to import the WSDL into Salesforce.

The imported Zuora WSDL is to be used by Zuora CPQ Order Builder and viewing or downloading Invoice PDFs.

You can perform the following actions on the zSchema Setup page:

  • Import the Zuora WSDL that includes the objects and fields that you want to use into Salesforce.
  • Create custom fields in the cached schema to match any custom fields created in Zuora.
  • Edit or delete custom fields.
  • Clear the Schema cache.

ZSchemaSetup.png

To upload Zuora WSDL to Salesforce:

  1. In Salesforce, click the + tab and then click Schema Setup.
  2. On the zSchema Setup page, click Clear Schema Cache. You must clear cache before uploading a new WSDL file.
  3. Click Choose File, and select the WSDL file.
  4. Click Upload.

Once you have imported the Zuora WSDL file into Salesforce, select any of the available objects to inspect it.

You may need to modify your code if field definitions change in the new WSDL file uploaded.

In your code, such as in Order Builder,  you need to set the values to an API field according to the field type definition in the fields table.  Otherwise the values will not be set. For example, for fieldsToNull, you need to set the value as a String array as below: 

zObject.setValue('fieldsToNull', new String[]{'TestField'}); 

To add a new custom field:

  1. In the Zuora Objects section, click the arrow for Zuora Objects field, and select the object to which you want to add a field.
  2. Click Add New Field to define new custom fields. You can edit or delete any custom field. 
  3. Enter the information for the new field, and click Add.

To edit or delete a custom field:

  1. In the Zuora Objects section, click the arrow for Zuora Objects field, and select the object to which you want to edit.
  2. For a field with the Is Zuora Custom Field field checked, click Edit or Delete to make changes.

You cannot undo the Delete operation. 

Clear the Schema Cache

Clearing schema cache removes all of the cached schema information from Salesforce. You must then re-import the Zuora WSDL into Salesforce and redefine any custom fields that you created.