listAndCount - Fulfillment Module Reference

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

This method retrieves a paginated list of fulfillment sets along with the total count of available fulfillment sets satisfying the provided filters.

Example

To retrieve a list of fulfillment sets using their IDs:

const [fulfillmentSets, count] =
  await fulfillmentModuleService.listAndCount({
    id: ["fuset_123", "fuset_321"],
  })

To specify relations that should be retrieved within the fulfillment set:

const [fulfillmentSets, count] =
  await fulfillmentModuleService.listAndCount(
    {
      id: ["fuset_123", "fuset_321"],
    },
    {
      relations: ["search_zones"],
    }
  )

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 [fulfillmentSets, count] =
  await fulfillmentModuleService.listAndCount(
    {
      id: ["fuset_123", "fuset_321"],
    },
    {
      relations: ["search_zones"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableFulfillmentSetProps

The filters to apply on the retrieved fulfillment sets.

configFindConfig<FulfillmentSetDTO>

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

sharedContextContext

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

Returns

PromisePromise<[FulfillmentSetDTO[], number]>Required

The list of fulfillment sets along with their total count.