createOrderLineItemAdjustments - Order Module Reference

This documentation provides a reference to the createOrderLineItemAdjustments method. This belongs to the Order Module.

NoteYou should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

createOrderLineItemAdjustments(data, sharedContext?): Promise<OrderLineItemAdjustmentDTO[]>#

This method creates line item adjustments.

Example#

Code
1const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments([{2  amount: 53}])

Parameters#

The line item adjustments to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderLineItemAdjustmentDTO[]>
The created line item adjustments.

createOrderLineItemAdjustments(data, sharedContext?): Promise<OrderLineItemAdjustmentDTO[]>#

This method creates a line item adjustment.

Example#

Code
1const lineItemAdjustment = await orderModuleService.createOrderLineItemAdjustments({2  amount: 53})

Parameters#

The line-item adjustment to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderLineItemAdjustmentDTO[]>
The created line-item adjustment.

createOrderLineItemAdjustments(orderId, data, sharedContext?): Promise<OrderLineItemAdjustmentDTO[]>#

This method creates line item adjustments for an order.

Example#

Code
1const lineItemAdjustments = await orderModuleService.createOrderLineItemAdjustments(2  "123",3  [{4    amount: 55  }]6)

Parameters#

orderIdstring
The order's ID.
The line-item adjustments to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderLineItemAdjustmentDTO[]>
The created line item adjustments.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break