listShippingMethodAdjustments - Cart Module Reference

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

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

Example

To retrieve a list of shipping method adjustments using their IDs:

const shippingMethodAdjustments =
  await cartModuleService.listShippingMethodAdjustments({
    id: ["casmadj_123", "casmadj_321"],
  })

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

const shippingMethodAdjustments =
  await cartModuleService.listShippingMethodAdjustments(
    {
      id: ["casmadj_123", "casmadj_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 shippingMethodAdjustments =
  await cartModuleService.listShippingMethodAdjustments(
    {
      id: ["casmadj_123", "casmadj_321"],
    },
    {
      relations: ["shipping_method"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableShippingMethodAdjustmentPropsRequired

The filters to apply on the retrieved shipping method adjustments.

configFindConfig<ShippingMethodAdjustmentDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingMethodAdjustmentDTO[]>Required

The list of shipping method adjustments.