SOAP API Calls
The calls in the Zuora SOAP API can be thought of as functioning much like verbs do in human languages: They are the actions that you perform. In human languages, verbs act upon objects, so in this case, the API calls are the actions you perform upon the Zuora SOAP API objects.
Zuora's SOAP API offers Create, Read, Update, and Delete (CRUD) capabilities. In this API, we use the term query instead of read.
Using 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:
- Header
- Body
- Operation (for example, create)
- Request
- Object name
- Fields for the object
- 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, anddelete, 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.
Errors when reaching concurrent request limits
You will encounter the following error codes, error messages, or HTTP status codes:
| Request Type | Error Code | Error Message | HTTP Status Code - Response Header |
|---|---|---|---|
| User Interface | N/A | "The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later." |
N/A |
| REST API | 50000070 |
"The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later." |
HTTP Status:429 Response Header: |
| SOAP API, version 51.0 and later |
|
|
HTTP Status:429 Response Header: |
| SOAP API, versions prior to 51.0 |
|
|
HTTP Status:429 Response Header: |
| File Download API | N/A | "The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later." |
HTTP Status:429 Response Header: |
Zuora recommends that you retry sending the request after 120 seconds.
We recommend that you test your integration in Zuora Sandbox and make sure you do not hit the concurrent request limits. Contact Zuora Global Support if you require additional assistance.