createOrderShippingMethods - Order Module Reference

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

createOrderShippingMethods(data, sharedContext?): Promise<OrderShippingMethodDTO>#

This method creates a shipping method.

Example#

Code
1const shippingMethod = await orderModuleService.createOrderShippingMethods({2  name: "Express Shipping",3  order_id: "123",4  amount: 105})

Parameters#

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

Returns#

PromisePromise<OrderShippingMethodDTO>
The created shipping method.

createOrderShippingMethods(data, sharedContext?): Promise<OrderShippingMethodDTO[]>#

This method creates shipping methods.

Example#

Code
1const shippingMethods = await orderModuleService.createOrderShippingMethods([{2  name: "Express Shipping",3  order_id: "123",4  amount: 105}])

Parameters#

The order shipping methods to be created.
sharedContextContextOptional
A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderShippingMethodDTO[]>
The created orders.

createOrderShippingMethods(orderId, methods, sharedContext?): Promise<OrderShippingMethodDTO[]>#

This method creates shipping methods for an order.

Example#

Code
1const shippingMethods = await orderModuleService.createOrderShippingMethods(2  "123",3  [4    {5      name: "Express Shipping",6      order_id: "123",7      amount: 108    }9  ]10)

Parameters#

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

Returns#

PromisePromise<OrderShippingMethodDTO[]>
The created shipping methods.
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