addShippingMethodTaxLines - Cart Module Reference

This documentation provides a reference to the addShippingMethodTaxLines 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.

addShippingMethodTaxLines(taxLines): Promise<ShippingMethodTaxLineDTO[]>#

This method creates and adds shipping method tax lines.

Example#

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

Parameters#

taxLinesCreateShippingMethodTaxLineDTO[]

The shipping method tax lines to be created.

Returns#

PromisePromise<ShippingMethodTaxLineDTO[]>

The added shipping method tax lines.

addShippingMethodTaxLines(taxLine): Promise<ShippingMethodTaxLineDTO>#

This method creates and adds a shipping method tax line.

Example#

Code
1const shippingMethodTaxLine =2  await cartModuleService.addShippingMethodTaxLines({3    code: "1000",4    rate: 10,5  })

Parameters#

taxLineCreateShippingMethodTaxLineDTO

The shipping method tax line to be created.

Returns#

PromisePromise<ShippingMethodTaxLineDTO>

The added shipping method tax line.

addShippingMethodTaxLines(cartId, taxLines, sharedContext?): Promise<ShippingMethodTaxLineDTO[]>#

This method creates and adds one or more shipping method tax lines to a cart.

Example#

Code
1const shippingMethodTaxLines =2  await cartModuleService.addShippingMethodTaxLines(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.

taxLinesCreateShippingMethodTaxLineDTO | CreateShippingMethodTaxLineDTO[]

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?