archive - Order Module Reference

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

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

This method sets the status of orders to archived.

Code
const orders = await orderModuleService.archive(["123", "321"])

orderIdsstring[]

The orders' ID.

sharedContextContextOptional

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

PromisePromise<OrderDTO[]>

The archived orders.

This method sets the status of an order to archived.

Code
const order = await orderModuleService.archive("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 archived order.