Get Started
Product
Resources
Tools & SDKs
Framework
Reference

updateOrderLineItems - Order Module Reference

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

updateOrderLineItems(data, sharedContext?): Promise<OrderLineItemDTO[]>#

This method updates existing line items. The line item to update is specified by the selector property of the first parameter.

Example#

Code
1const lineItems = await orderModuleService.updateOrderLineItems([2  {3    selector: {4      id: "123"5    },6    data: {7      quantity: 28    }9  }10])

Parameters#

dataUpdateOrderLineItemWithSelectorDTO[]

The attributes to update in the order line item with selector.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderLineItemDTO[]>

The updated line items.

updateOrderLineItems(selector, data, sharedContext?): Promise<OrderLineItemDTO[]>#

This method updates existing line items matching the specified filters.

Example#

Code
1const lineItems = await orderModuleService.updateOrderLineItems({2  id: "123"3}, {4  quantity: 25})

Parameters#

selectorPartial<FilterableOrderLineItemProps>

The filters specifying which line items to update.

dataPartial<UpdateOrderLineItemDTO>

The data to update in the line items.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderLineItemDTO[]>

The updated line items.

updateOrderLineItems(lineId, data, sharedContext?): Promise<OrderLineItemDTO>#

This method updates an existing line item.

Example#

Code
1const lineItem = await orderModuleService.updateOrderLineItems(2  "123",3  {4    quantity: 25  }6)

Parameters#

lineIdstring

The line items's ID.

dataPartial<UpdateOrderLineItemDTO>

The data to update in the line item.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderLineItemDTO>

The updated line item.

Was this page helpful?