listShippingProfiles - Fulfillment Module Reference

This documentation provides a reference to the listShippingProfiles method. This belongs to the Fulfillment Module.

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

Example

To retrieve a list of shipping profiles using their IDs:

const shippingProfiles =
  await fulfillmentModuleService.listShippingProfiles({
    id: ["sp_123", "sp_321"],
  })

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

const shippingProfiles =
  await fulfillmentModuleService.listShippingProfiles(
    {
      id: ["sp_123", "sp_321"],
    },
    {
      relations: ["shipping_options"],
    }
  )

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 shippingProfiles =
  await fulfillmentModuleService.listShippingProfiles(
    {
      id: ["sp_123", "sp_321"],
    },
    {
      relations: ["shipping_options"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableShippingProfileProps

The filters to apply on the retrieved shipping profiles.

configFindConfig<ShippingProfileDTO>

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

sharedContextContext

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

Returns

PromisePromise<ShippingProfileDTO[]>Required

The list of shipping profiles.