listFulfillments - Fulfillment Module Reference

This documentation provides a reference to the listFulfillments method. This belongs to the Fulfillment 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 fulfillments based on optional filters and configuration.

Example#

To retrieve a list of fulfillments using their IDs:

Code
1const fulfillments =2  await fulfillmentModuleService.listFulfillments({3    id: ["ful_123", "ful_321"],4  })

To specify relations that should be retrieved within the fulfillment:

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 fulfillments =2  await fulfillmentModuleService.listFulfillments(3    {4      id: ["ful_123", "ful_321"],5    },6    {7      relations: ["shipping_option"],8    }9  )

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 fulfillments =2  await fulfillmentModuleService.listFulfillments(3    {4      id: ["ful_123", "ful_321"],5    },6    {7      relations: ["shipping_option"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterableFulfillmentPropsOptional

The filters to apply on the retrieved fulfillments.

configFindConfig<FulfillmentDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<FulfillmentDTO[]>

The list of fulfillments.