setLineItemTaxLines - Cart Module Reference

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

Example#

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

Parameters#

cartIdstring

The cart's ID.

taxLines(CreateLineItemTaxLineDTO | UpdateLineItemTaxLineDTO)[]

The line 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<LineItemTaxLineDTO[]>

The added line item tax lines.

Was this page helpful?