Home > @vsf-enterprise/sap-commerce-webservices-sdk > CartsApi > getCartPromotions

CartsApi.getCartPromotions() method

Returns information about the promotions 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 promotions applied on cart.

Signature:

getCartPromotions(baseSiteId: string, cartId: 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, &#39;current&#39; for the last modified cart
userId string User identifier or one of the literals : &#39;current&#39; for currently authenticated user, &#39;anonymous&#39; 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