listShippingMethods - Cart Module Reference

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

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:

const shippingMethods =
  await cartModuleService.listShippingMethods(
    {
      id: ["casm_123", "casm_321"],
    },
    {}
  )

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

const shippingMethods =
  await cartModuleService.listShippingMethods(
    {
      id: ["casm_123", "casm_321"],
    },
    {
      relations: ["cart"],
    }
  )

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 shippingMethods =
  await cartModuleService.listShippingMethods(
    {
      id: ["casm_123", "casm_321"],
    },
    {
      relations: ["cart"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableShippingMethodPropsRequired

The filters to apply on the retrieved shipping methods.

configFindConfig<CartShippingMethodDTO>Required

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.

sharedContextContext

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

Returns

PromisePromise<CartShippingMethodDTO[]>Required

The list of shipping methods.