Generic API Operations in Salesforce (SOAP)
The following methods are provided in the Enterprise or Partner WSDL as generic core API calls that allow you primarily to perform CRUD actions on standard and custom Salesforce objects (also referred to as "data setup"). Refer to Salesforce Developer documentation for complete information on calling these methods. The examples provided on this page will aid you in performing CRUD actions and querying information from the Salesforce database to use in Conga API calls.
Retrieving the Server URL and Session Id (Login)
All API calls to your organization require you to authenticate with a valid Session Id.
Method: login()
Request: Pass the username and password for the user providing authentication.
Example Request
Response: Returns the serverURL and session Id.
Example Response
Retrieving an Opportunity
Method: query()
Request: Pass the session Id and Opportunity Name.
Example Request
Response: Returns the Opportunity Id and Size (indicates number of Ids)
Example Response
Creating a Price List
Method: create()
Request: Pass the session Id and Price List Name.
Example Request
Response: Returns the Price List Id with status = 'true' if the Price List was successfully created.
Example Response
Retrieving a Price List
Method: query()
Request: Pass the session Id and Price List Name.
Example Request
Response: Returns the Price List Id.
Example Response
Creating a Product Category
Method: create()
Request: Pass the session Id, Category Name, and Category Label.
Example Request
Response: Returns the Category Id with status = 'true' if the Category was successfully created.
Example Response
Retrieving a Category
Method: query()
Request: Pass the session Id and Category Name.
Example Request
Response: Returns the Category Id, Category Name, and Size (indicates number of Ids).
Example Response
Creating a Standalone Product
Method: create()
Request: Pass the session Id, Product Name, and Configuration Type.
Example Request
Response: Returns the Product Id with status = 'true' if the Product was successfully created.
Example Response
Retrieving a Standalone Product
Method: query()
Request: Pass the session Id and Product Name.
Example Request
Response: Returns the Standalone Product Id, Product Name, and Size (indicates the number of Ids).
Example Response
Creating a Bundle Product
Method: create()
Request: Pass the session Id, Product Name, and Configuration Type.
Example Request
Response: Returns the Product Id with status = 'true' if the Bundle Product was successfully created.
Example Response
Retrieving a Bundle
Method: query()
Request: Pass the session Id and Product Name.
Example Request
Response: Returns the Bundle Id and Product Name, and Size (indicates the number of Ids).
Example Response
Creating an Option Product
Method: create()
Request: Pass the session Id, Product Name, and Configuration Type.
Example Request
Response: Returns the Product Id with status = 'true' if the Option Product was successfully created.
Example Response
Retrieving an Option
Method: query()
Request: Pass the session Id and Product Name.
Example Request
Response: Returns the Option Id, Product Name, and Size (indicates the number of Ids).
Example Response
Retrieving Component Id for a Product, Bundle, or Option
Method: query()
Request: Pass the session Id and Product Id.
Example Request
Response: Returns the Component Product Id.
Example Response
On this page
- Retrieving the Server URL and Session Id (Login)
- Retrieving an Opportunity
- Creating a Price List
- Retrieving a Price List
- Creating a Product Category
- Retrieving a Category
- Creating a Standalone Product
- Retrieving a Standalone Product
- Creating a Bundle Product
- Retrieving a Bundle
- Creating an Option Product
- Retrieving an Option
- Retrieving Component Id for a Product, Bundle, or Option