Get Started
Product
Resources
Tools & SDKs
Framework
Reference

retrieveOrderClaim - Order Module Reference

This documentation provides a reference to the retrieveOrderClaim 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 claim by its ID.

Example#

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

Code
1const claim = await orderModuleService.retrieveOrderClaim(2  "123"3)

To specify relations that should be retrieved:

Code
1const claim = await orderModuleService.retrieveOrderClaim(2  "123",3  {4    relations: ["order"]5  }6)

Parameters#

claimIdstring

The claim's ID.

configFindConfig<OrderClaimDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<OrderClaimDTO>

The retrieved order claim.

Was this page helpful?