Skip to main content
Skip to main content

listShippingMethodTaxLines - Cart Module Reference

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

This method retrieves a paginated list of shipping method tax lines based on optional filters and configuration.

Example

To retrieve a list of shipping method tax lines using their IDs:

const shippingMethodTaxLines =
await cartModuleService.listShippingMethodTaxLines({
id: ["casmtxl_123", "casmtxl_321"],
})

To specify relations that should be retrieved within the shipping method tax lines:

const shippingMethodTaxLines =
await cartModuleService.listShippingMethodTaxLines(
{
id: ["casmtxl_123", "casmtxl_321"],
},
{
relations: ["shipping_method"],
}
)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const shippingMethodTaxLines =
await cartModuleService.listShippingMethodTaxLines(
{
id: ["casmtxl_123", "casmtxl_321"],
},
{
relations: ["shipping_method"],
take: 20,
skip: 2,
}
)

Parameters

The filters to apply on the retrieved shipping method tax lines.
The configurations determining how the shipping method tax line is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a shipping method tax line.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<ShippingMethodTaxLineDTO[]>Required
The list of shipping method tax lines.
Was this section helpful?