Working with Delete in Zuora SOAP

Overview

The following operations allow you to work with "delete". Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with "delete", see Sample configuration.

Operation	Description
delete	Use to delete one or more zobjects of a specific type.

Operation details

This section provides details on the operations.

Getting the user information

The delete operation is used to delete one or more zobjects of a specific type.

delete

<zuorasoap.delete>
    <zobjectType>{$ctx:zobjectType}</zobjectType>
	<zobjects>{$ctx:zobjects}</zobjects>
</zuorasoap.delete>

Properties

zobjectType: The type of zobject to be deleted.
zobjects: The list of one or more IDs for the objects to be deleted.

Sample request

Following is a sample SOAP request that can be handled by the delete operation.

Sample Request for delete

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="wso2.connector.zuora">
  <soapenv:Header/>
   <soapenv:Body>
      <urn:apiUrl>https://apisandbox.zuora.com/apps/services/a/74.0</urn:apiUrl>
      <urn:username>zuora@wso2.com</urn:username>
      <urn:password>Zuora#123</urn:password>
	  <urn:zobjectType>Account</urn:zobjectType>
      <urn1:zObjects xmlns:urn1="http://api.zuora.com/">
         <Ids>2c92c0f9528db6aa015292b0f7bb15f4</Ids>
         <Ids>2c92c0f9528db6aa015292b0f7c915f6</Ids>
      </urn1:zObjects>
   </soapenv:Body>
</soapenv:Envelope>

Sample configuration

Following is a sample proxy service that illustrates how to connect to Zuora with the init operation and use the delete operation. The sample request for this proxy can be found in delete sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy

     <?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="delete"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property xmlns:ns="wso2.connector.zuora"
                   name="apiUrl"
                   expression="//ns:apiUrl/text()"/>
         <property xmlns:ns="wso2.connector.zuora"
                   name="username"
                   expression="//ns:username/text()"/>
         <property xmlns:ns="wso2.connector.zuora"
                   name="password"
                   expression="//ns:password/text()"/>
         <property xmlns:ns="wso2.connector.zuora"
                   name="zobjectType"
                   expression="//ns:zobjectType/text()"/>
         <property xmlns:ns1="http://api.zuora.com/"
                   name="zobjects"
                   expression="//ns1:zObjects"/>
         <zuorasoap.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <username>{$ctx:username}</username>
            <password>{$ctx:password}</password>
         </zuorasoap.init>
         <zuorasoap.delete>
            <zobjectType>{$ctx:zobjectType}</zobjectType>
            <zobjects>{$ctx:zobjects}</zobjects>
         </zuorasoap.delete>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>

WSO2 ESB Connectors Documentation