Detailed API Parameters and Calling Information
The rows in this table provide detailed information about the calling parameters and methods for each of the Vlocity Communications APIs.
| API | Description |
|---|---|
| Get Offers by Catalog API | Provides the ability to retrieve a list of offers (products or promotions) that are modeled within the Shared Catalog. The specified catalog code identifies the catalog that contains the offers. Offer eligibility can be determined by API parameters which support both anonymous and known user journeys. Eligibility can be controlled using context rules. Offer eligibility is determined by the default values for the context dimensions. See Context Eligibility Rules. |
| Get Featured Offers API | Provides the ability to retrieve a list of offers (products or promotions) that are modeled within the Shared Catalog, which is sorted by a specified Catalog Product Relationship field. The specified catalog code identifies the catalog that contains the offers. Offer eligibility can be determined by API parameters which support both anonymous and known user journeys. |
| Get Contains Products API | Provides the ability to retrieve a list of offers (products or promotions) that are modeled within the Shared Catalog which contain the specified product. The specified catalog code identifies the catalog that contains the offers. Offer eligibility can be determined by API parameters which support both anonymous and known user journeys. |
| Get Offer Details API | Provides the ability to retrieve offer (product or promotion) details that are modeled within the Shared Catalog. The specified catalog code identifies the catalog that contains the offers. Offer eligibility can be determined by API parameters which support both anonymous and known user journeys. |
| Post Offer Details with Configuration API | Provides the ability to pass offer details that are modeled within the Shared Catalog in order to retrieve pricing updates. The specified catalog code identifies the catalog that contains the offers. Pricing eligibility can be determined by API parameters which support only an anonymous journey. |
| Create Basket with BasketAction API | Provides the ability to create a basket with or without offer (product or promotions) configurations that are modeled within the Shared Catalog. The specified catalog code identifies the catalog that contains the offers. <>(BasketAction: AddWithNoConfig): Add items to the basket without configuration.(BasketAction: AddAfterConfig): Add items to the basket with configuration.(BasketAction: AssetToBasket): Create basket as part of an asset based order.</> |
| Update Basket Contents API | Provides the ability to add or delete offers to or from a virtual basket. You use the cartContextKey to keep track of the basket. The cartContextKey is not required if the basket is empty. The CartContextKey is returned as part of the response after a successful basket operation. |
| Get Basket Details API | Retrieves details about a basket. |
| Create Cart from Basket API | Create Order Cart from Basket. Provides the ability to create a cart from a basket with offers (product or promotions) and its configurations that are modeled within the Shared Catalog. The specified catalog code identifies the catalog that contains the offers. |