retrieveOrder - Order Module Reference

This documentation provides a reference to the retrieveOrder 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 an order by its ID.

Example#

A simple example that retrieves an order change by its ID:

Code
1const order = await orderModuleService.retrieveOrder(2  "123"3)

To specify relations that should be retrieved:

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 order = await orderModuleService.retrieveOrder(2  "123",3  {4    relations: ["items"]5  }6)

Parameters#

orderIdstring

The order's ID.

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 retrieved order.