Welcome to Zuora Product Documentation

Explore our rich library of product information

Create SOAP Requests

Create SOAP requests in Zuora by navigating through the Generic API Utility, configuring execution settings, and generating request templates.

Ensure that the "API Write Access" permission is enabled for your user role in the Zuora tenant.

  1. Navigate to New Task > Generic API Utility .
  2. In the General tab, complete the following settings:
    1. Select the timing of execution from the Execution drop-down list. The default value is Onetime.
      • Onetime - The task will be executed immediately when the resource is available.

      • Scheduled - The task will be executed on the date and time specified in the schedule builder.

    2. Select the login to your Zuora tenant from the Source drop-down list or create a new login. Do not select OAuth credentials or create new logins using OAuth because OAuth is not supported by Developer Tools.
    3. Select the operation you want to perform from the Operation drop-down list.
    4. Select the Zuora object on which you want to operate from the Object drop-down list.
  3. Click Generate. The SOAP request template is then generated in the text box.
  4. Edit the generated template based on your needs.
  5. (Optional) In the Options tab, update the XML namespaces, batch size, exported file format, or whether to perform the request as a single transaction in Zuora.
  6. If you selected Scheduled for the Execution field, complete the scheduler settings in the Schedule tab.
    1. Select the time zone from the Timezone drop-down list. Zuora strongly recommends you to select the same time zone as for your Zuora tenant to avoid payment errors.
    2. In the drop-down list next to Timezone , select the time frame of the schedule and complete the details of the selected time frame. The Timezone field and schedule builder are used to set how frequently the data is synchronized. It is recommended to set a Daily schedule and align the timezone to your Zuora tenant, which can align operations and ensure the app displays the latest data. The Interval field displays the specified schedules as a Cron expression and needs no further configuration.
  7. Click Create Task .

    Alternatively, you can directly paste the ready-to-use SOAP request in the text box and click Create Task to make the request.