Get Started
Product
Resources
Tools & SDKs
Framework
Reference

listOrders - Order Module Reference

This documentation provides a reference to the listOrders 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 orders based on optional filters and configuration.

Example#

To retrieve a list of orders using their IDs:

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

To specify relations that should be retrieved within the order:

Code
1const orders = await orderModuleService.listOrders({2  id: ["123", "321"]3}, {4  relations: ["items"]5})

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 orders = await orderModuleService.listOrders({2  id: ["123", "321"]3}, {4  relations: ["items"],5  take: 20,6  skip: 27})

Parameters#

filtersFilterableOrderPropsOptional

The filters to apply on the retrieved order.

configFindConfig<OrderDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<OrderDTO[]>

The list of orders.

Was this page helpful?