Salesforce APIs

This documentation provides an overview of the Salesforce APIs supported by Valorx Fusion, detailing how these APIs enable seamless integration and enhance functionality within the platform.

CPQ APIs

The CPQ APIs provide essential functionality for managing quotes, products, and related data within Salesforce CPQ. These APIs facilitate tasks like reading, validating, calculating, and saving quotes, as well as adding and retrieving products.

These CPQ APIs will be available in the workflow only if your Salesforce org has the Salesforce CPQ package installed and the Quote and Quote Line objects are included in the data model. Only then will you be able to access and use the CPQ API tasks within the workflow.

Below is a summary of the core properties and functionalities of the CPQ APIs:

1. Read Quote API

Description: Retrieves detailed information about a specific quote, including its associated Quote Lines and related data.

Read Quote API

Use Case:

  • Fetching the current state of a quote for review or updates.

Inputs:

  • Quote Form Map

Outputs:

  • Quote Model with Quote Lines

2. Calculate Quote API

Description: Performs pricing calculations for a quote, applying rules such as discounts, taxes, and promotions.

Calculate Quote API

Use Case:

  • Ensuring accurate pricing before finalizing a quote.

Inputs:

  • Quote Form Map

  • Quote Line Grid Map

Outputs:

  • Updated Quote Model with calculated prices

3. Validate Quote API

Description: Checks the quote for errors or discrepancies, ensuring it meets predefined business rules.

Validate Quote API

Use Case:

  • Verifying quote accuracy before submission or approval.

Inputs:

  • Quote Model

Outputs:

  • Validation Results (Pass/Fail)

  • List of Errors (if any)

4. Save Quote API

Description: Saves changes made to the quote and updates the Quote Model in Salesforce.

Save Quote API

Use Case:

  • Persisting updates to a quote after modifications.

Inputs:

  • Updated Quote Model

Outputs:

  • Confirmation of successful save

5. Read Product API

Description: Retrieves product information from the Salesforce Product Catalog.

Read Quote API

Use Case:

  • Fetching product details for inclusion in a quote.

Inputs:

  • Product ID or Filter Criteria

Outputs:

  • Product Details

6. Add Product API

Description: Adds a product to a specific quote, updating the Quote Line Model.

Add Product API

Use Case:

  • Including additional products in an existing quote.

Inputs:

  • Quote ID

  • Product ID

  • Quantity

Outputs:

  • Updated Quote Model with the new product

Notes

  • These APIs are designed to integrate seamlessly with Salesforce CPQ functionality.

  • Proper authentication and API permissions are required for access.

  • Responses are returned in standard Salesforce data formats (e.g., JSON or XML).

By leveraging these APIs, users can automate and streamline their quote and product management processes, improving efficiency and accuracy.

Last updated