listOrderShippingMethodTaxLines - Order Module Reference
This documentation provides a reference to the listOrderShippingMethodTaxLines
method. This belongs to the Order Module.
Note: You should only use this methods when implementing complex customizations. For common cases, check out
available workflows instead.
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:
1const shippingMethodTaxLines = await orderModuleService2 .listOrderShippingMethodTaxLines({3 id: ["123", "321"]4 })
To specify relations that should be retrieved within the shipping method tax line:
Note: You can only retrieve data models defined in the same module. To retrieve linked data models
from other modules, use
Query instead.
1const shippingMethodTaxLines = await orderModuleService2 .listOrderShippingMethodTaxLines({3 id: ["123", "321"]4 }, {5 relations: ["shipping_method"]6 })
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
1const shippingMethodTaxLines = await orderModuleService2 .listOrderShippingMethodTaxLines({3 id: ["123", "321"]4 }, {5 relations: ["shipping_method"],6 take: 20,7 skip: 28 })
Parameters#
The filters to apply on the retrieved shipping method tax line.
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.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#
The list of shipping method tax lines.