setShippingMethodAdjustments - Cart Module Reference

This documentation provides a reference to the setShippingMethodAdjustments method. This belongs to the Cart Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method sets the shipping method adjustment of shipping methods in a cart. The existing shipping method adjustments, except those included in the specified list, of an item are removed and replaced with the specified adjustments.

Example#

Code
1const shippingMethodAdjustments =2  await cartModuleService.setShippingMethodAdjustments(3    "cart_123",4    [5      {6        id: "casmadj_123",7        shipping_method_id: "casm_123",8        code: "FREESHIPPING",9      },10      {11        shipping_method_id: "casm_321",12        code: "10%OFF",13        amount: 1500,14      },15    ]16  )

Parameters#

cartIdstring

The cart's ID.

data(CreateShippingMethodAdjustmentDTO | UpdateShippingMethodAdjustmentDTO)[]

The shipping method adjustments to add to the shipping method. If the id field is specified, the adjustment is kept in the shipping method's adjustment and its attributes can be updated.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<ShippingMethodAdjustmentDTO[]>

The added shipping method adjustments.

Was this page helpful?