- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
updateOrderItem - Order Module Reference
This documentation provides a reference to the updateOrderItem
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.
updateOrderItem(selector, data, sharedContext?): Promise<OrderItemDTO[]>#
This method updates existing order items matching the specified filters.
Example#
Parameters#
selector
Partial<FilterableOrderShippingMethodProps>The filters specifying which order items to update.
selector
Partial<FilterableOrderShippingMethodProps>The attributes to update in the order item.
Returns#
Promise
Promise<OrderItemDTO[]>The updated order items.
Promise
Promise<OrderItemDTO[]>updateOrderItem(orderItemId, data, sharedContext?): Promise<OrderItemDTO>#
This method updates an existing order item.
Example#
Parameters#
orderItemId
stringThe order item's ID.
data
Partial<UpdateOrderItemDTO>The data to update in the order item.
data
Partial<UpdateOrderItemDTO>Returns#
Promise
Promise<OrderItemDTO>The updated order item.
Promise
Promise<OrderItemDTO>updateOrderItem(orderItemIdOrDataOrSelector, data?, sharedContext?): Promise<OrderItemDTO | OrderItemDTO[]>#
This method updates existing order items. The items are identified either by their ID or the specified filters.
Example#
Parameters#
orderItemIdOrDataOrSelector
string | Partial<OrderItemDTO> | UpdateOrderItemWithSelectorDTO[]Either the ID of an order item, or the
filters specifying which order items to update.
orderItemIdOrDataOrSelector
string | Partial<OrderItemDTO> | UpdateOrderItemWithSelectorDTO[]The data to update.
Returns#
Promise
Promise<OrderItemDTO | OrderItemDTO[]>The updated order items.
Promise
Promise<OrderItemDTO | OrderItemDTO[]>Was this page helpful?