Use the SOAP API calls

The Zuora SOAP API calls can be thought of as verbs, because they perform the CRUD actions on the API objects. Using the calls, you can perform various tasks:

• Logging into the Zuora server: Use login call to allow you receive information for subsequent calls

• Creating, updating, and deleting various types of information. Use the create, update, or delete call

• Querying account information. Use the query call

As an alternative, you can use the subscribe call, which is an all-in-one solution for creating a request to subscribe to a service.

If you have the Invoice Settlement feature enabled, Zuora does not support generating credit memos with the API calls.

The XML of your calls must follow this format:

1. Header

2. Body

3. Operation (for example, create)

4. Request

5. Object name

6. Fields for the object

7. Additional operations

Except for the login call, use only one header per call.

Properties of the SOAP API Calls

All Zuora API calls are:

• Service requests and responses: Using the SOAP API, your client application prepares and submits a service request to the Zuora Web service. The Web service processes that request and returns a response, which your client application handles.

• Synchronous only (asynchronous calls are not supported): Once your client application makes a request, it waits until it receives a response from the service before taking further action.

• Committed automatically: Every operation that writes to an object is committed automatically. This can be compared to the AUTOCOMMMIT setting in SQL. For create, update, and delete, if you attempt to write to more than one record in an object, the write operation for each record is treated as a separate transaction. For example, if a client application attempts to create two new accounts, those accounts are created using mutually exclusive insert operations that succeed or fail individually, not as a group.

Your client applications may need to handle failures if a requested operation could not be completed.

Concurrent Request Limits

See Concurrent request limits on the Developer Center for details.

You will encounter the following error codes, error messages, or HTTP status codes when reaching concurrent request limits:

<fns:FaultCode>
REQUEST_EXCEEDED_LIMIT</fns:FaultCode>

<fns:FaultMessage> The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later. </fns:FaultMessage>

<fns:FaultCode> 
UNKNOWN_ERROR
</fns:FaultCode>

<fns:FaultMessage> The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later. </fns:FaultMessage>

Zuora recommends that you retry sending the request after 120 seconds.