setShippingMethodTaxLines - Cart Module Reference

This documentation provides a reference to the setShippingMethodTaxLines 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 item tax lines in a cart. The shipping line item tax lines, except those included in the specified list, are removed and replaced with the specified tax lines.

Example#

Code
1const shippingMethodTaxLines =2  await cartModuleService.setShippingMethodTaxLines(3    "cart_123",4    [5      {6        code: "1000",7        rate: 10,8      },9      {10        code: "1234",11        rate: 20,12      },13    ]14  )

Parameters#

cartIdstring

The cart's ID.

taxLines(CreateShippingMethodTaxLineDTO | UpdateShippingMethodTaxLineDTO)[]

The shipping item tax lines to add. If the id field is specified, the tax line is kept 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<ShippingMethodTaxLineDTO[]>

The added shipping method tax lines.

Was this page helpful?