Home > @vsf-enterprise/sap-commerce-webservices-sdk > CartsApi > getCartPromotion
CartsApi.getCartPromotion() method
Returns information about a promotion (with a specific promotionId), that has been applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine. Get information about promotion applied on cart.
Signature:
getCartPromotion(baseSiteId: string, cartId: string, promotionId: string, userId: string, fields?: 'BASIC' | 'DEFAULT' | 'FULL', options?: any): Promise<import("axios").AxiosResponse<PromotionResultList>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| baseSiteId | string | Base site identifier |
| cartId | string | Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
| promotionId | string | Promotion identifier (code) |
| userId | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
| fields | 'BASIC' | 'DEFAULT' | 'FULL' | Response configuration. This is the list of fields that should be returned in the response body. |
| options | any | Override http request option. |
Returns:
Promise<import("axios").AxiosResponse<PromotionResultList>>
Exceptions
{RequiredError} CartsApi