listOrderChanges - Order Module Reference

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

Example#

To retrieve a list of order changes using their IDs:

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

To specify relations that should be retrieved within the exchange:

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

Parameters#

filtersFilterableOrderChangePropsOptional

The filters to apply on the retrieved order changes.

configFindConfig<OrderChangeDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<OrderChangeDTO[]>

The list of order changes.