Poq.SDK.Node

Home > @poq/sdk-sfcc > IBasketsClient > patchBasketsByIDPriceAdjustmentsByID

IBasketsClient.patchBasketsByIDPriceAdjustmentsByID() method

Updates a custom manual price adjustment on the basket. Only the following PATH values are considered for the update: discount, item_text, reason_code and custom properties; all other attributes are ignored. The discount type of a price adjustment cannot be updated and therefore, the value of the existing type must be passed. For an adjustment of type PERCENTAGE, the ‘percentage’ attribute is mandatory. For adjustments of type AMOUNT and FIXED_PRICE, the ‘amount’ attribute is mandatory.

Signature:

patchBasketsByIDPriceAdjustmentsByID(basketId: string, priceAdjustmentId: string, body: PriceAdjustment, options?: RequestOptions): Promise<PoqResponse<Basket>>;

Parameters

Parameter Type Description
basketId string the id of the basket to be modified
priceAdjustmentId string the uuid of the adjustment to be updated
body PriceAdjustment  
options RequestOptions (Optional) Override http request option.

Returns:

Promise<PoqResponse<Basket>>