listOrderShippingMethods - Order Module Reference

This documentation provides a reference to the listOrderShippingMethods 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 methods based on optional filters and configuration.

Example#

To retrieve a list of shipping methods using their IDs:

Code
1const shippingMethods = await orderModuleService.listOrderShippingMethods({2  id: ["123", "321"]3}, {})

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

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const shippingMethods = await orderModuleService.listOrderShippingMethods({2  id: ["123", "321"]3}, {4  relations: ["adjustments"]5})

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

Code
1const shippingMethods = await orderModuleService.listOrderShippingMethods({2  id: ["123", "321"]3}, {4  relations: ["adjustments"],5  take: 20,6  skip: 27})

Parameters#

filtersFilterableOrderShippingMethodProps

The filters to apply on the retrieved shipping method.

configFindConfig<OrderShippingMethodDTO>

The configurations determining how the shipping method is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a shipping method.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderShippingMethodDTO[]>

The list of shipping methods.