listOrderAddresses - Order Module Reference

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

Example#

To retrieve a list of addresses using their IDs:

Code
1const addresses = await orderModuleService.listOrderAddresses({2  id: ["123", "321"]3})

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 addresses = await orderModuleService.listOrderAddresses({2  id: ["123", "321"]3}, {4  take: 20,5  skip: 26})

Parameters#

filtersFilterableOrderAddressPropsOptional

The filters to apply on the retrieved order addresss.

configFindConfig<OrderAddressDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<OrderAddressDTO[]>

The list of addresses.