completeOrder - Order Module Reference

This documentation provides a reference to the completeOrder 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.

completeOrder(orderIds, sharedContext?): Promise<OrderDTO[]>#

This method sets the status of orders to completed.

Code
1const orders = await orderModuleService.completeOrder([2  "123", "321"3])

orderIdsstring[]

The orders' IDs.

sharedContextContextOptional

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

PromisePromise<OrderDTO[]>

The completed orders.

This method sets the status of an order to completed.

Code
const order = await orderModuleService.completeOrder("123")

orderIdstring

The order's ID.

sharedContextContextOptional

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

PromisePromise<OrderDTO>

The completed order.

Was this page helpful?