jSpring 2025
Standard Digital Commerce APIs are RESTful Web APIs designed to enable client applications such as consumer-facing web and mobile apps to shop for products and services. The Digital Commerce APIs are optimized for consumer shopping use cases where the user may be anonymous until well into the check-out process. These APIs are also optimized to enable caching of API responses to provide performance enhancements and scalability. Finally, these APIs are optimized for lower bandwidth connections between the client app and the server by minimizing the metadata returned in the response. The Digital Commerce APIs are provided in addition to the Vlocity Cart Based APIs. The Cart Based APIs are optimized for highly interactive cart operations done by contact center agents and sales reps using an editor such as the Vlocity Cart UI. Therefore, Cart Based APIs provide more metadata to the client browser enabling a wide array of operations. Both the Cart Based CPQ APIs and the Digital Commerce APIs continues to be supported and actively enhanced. The Digital Commerce APIs are not intended to replace the Cart based APIs.
All of the Vlocity Omnichannel REST APIs simplify client app development by hiding the details of internal CPQ processing. Client-side developers do not need to understand details of the underlying CPQ logic: no need to know the proper order to apply eligibility and availability rules and no need to learn the methods of the underlying CPQ rules engines and other CPQ services.
The basic flow of API calls with the digital commerce APIs is as follows:
- Get eligible offers from a catalog: GET /v3/catalogs/{catalogcode}/offers
- Get the details of a specific offer retrieved from the previous call: GET /v3/catalogs/{catalogcode}/offers/{offercode}
- Get the details of a specific offer with attribute values specified: POST /v3/catalogs/{catalogcode}/offers/{offercode}
- Preview details of multiple offers with attribute values specified: POST /v3/preview/catalogs/{catalogcode}/offers [Only when Standard DC is enabled]
The above APIs retrieve eligible offers (products and/or promotions) from the specified catalog based on the customer context provided in the request, but these APIs only return default "starts-with" and base pricing information. To request more specific pricing and feedback on the validity of the configured bundle, use the basket APIs that follow.
- Get a basket containing a configured offer bundle using an offer details response (3 above): POST /v3/catalogs/{catalogcode}/basket
- Get a modification of the previous basket adding another bundle or deleting a bundle: POST /v3/catalogs/{catalogcode}/basket/{basketkey}
The basket APIs get specific pricing for the context given by executing the Vlocity CPQ pricing services. The API returns a basket key that is a hash form of a cart containing the chosen items as configured.
- Create a cart in Salesforce for a specific customer using the basket response (4 or 5 above): POST /v3/carts
Let us know so we can improve!