Call Basics
From API Documentation
Zuora's Z-Commerce API offers Create, Read, Update, and Delete capabilities. In this API, we use the term query instead of read, which gives a bit more depth to the capability, but it is essentially the same process.
The Z-Commerce API calls can be thought of as verbs in that they perform the CRUD actions upon the Z-Commerce API objects. Using the calls, you can perform various tasks such as
- Logging in to the Zuora server (login) and receiving information to be used for subsequent calls
- Creating, updating, and deleting various types of information (create, update, and delete)
- Querying account information (query)
As an alternative, you can Invoke the subscribe call, which is an all-in-one solution for creating a request to subscribe to a service.
See API Calls for detailed information about each call.
All API calls are:
- Service requests and responses. Using the 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 some failures if a requested operation could not be completed.
Standards Compliance
The API complies with the following specifications:
- Simple Object Access Protocol (SOAP) 1.1 http://www.w3.org/TR/soap/
- Web Service Description Language (WSDL) 1.1 http://www.w3.org/TR/wsdl
- WS-I Basic Profile 1.1 http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html
