updateOrders - Order Module Reference

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

updateOrders(data, sharedContext?): Promise<OrderDTO[]>#

This method updates existing orders. The order IDs are specified in each order object.

Code
1const orders = await orderModuleService.updateOrders([{2  id: "123",3  email: "example@gmail.com"4}])

The attributes to update in the order.

sharedContextContextOptional

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

PromisePromise<OrderDTO[]>

The updated orders.

This method updates existing orders.

Code
1const order = await orderModuleService.updateOrders(2  "123",3  {4    email: "example@gmail.com"5  }6)

orderIdstring

The ID of the order to update.

The attributes to update in the order.

sharedContextContextOptional

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

PromisePromise<OrderDTO>

The updated orders.

This method updates existing orders matching the specified filters.

Code
1const orders = await orderModuleService.updateOrders({2  id: ["123", "321"]3}, {4  email: "example@gmail.com"5})

The filters specifying which orders to update.

The attributes to update in the orders.

sharedContextContextOptional

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

PromisePromise<OrderDTO[]>

The updated orders.

Was this page helpful?