Get Started
Product
Resources
Tools & SDKs
Framework
Reference

createOrderShippingMethodAdjustments - Order Module Reference

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

createOrderShippingMethodAdjustments(data, sharedContext?): Promise<OrderShippingMethodAdjustmentDTO[]>#

This method creates shipping method adjustments.

Example#

Code
1const shippingMethodAdjustments = await orderModuleService2  .createOrderShippingMethodAdjustments([3    {4      shipping_method_id: "123",5      code: "50OFF",6      amount: 57    }8  ])

Parameters#

dataCreateOrderShippingMethodAdjustmentDTO[]

The order shipping method adjustments to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderShippingMethodAdjustmentDTO[]>

The created shipping method adjustments.

createOrderShippingMethodAdjustments(data, sharedContext?): Promise<OrderShippingMethodAdjustmentDTO>#

This method creates a shipping method adjustment.

Example#

Code
1const shippingMethodAdjustment = await orderModuleService2  .createOrderShippingMethodAdjustments({3    shipping_method_id: "123",4    code: "50OFF",5    amount: 56  })

Parameters#

dataCreateOrderShippingMethodAdjustmentDTO

The shipping method adjustment to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderShippingMethodAdjustmentDTO>

The created shipping method adjustment.

createOrderShippingMethodAdjustments(orderId, data, sharedContext?): Promise<OrderShippingMethodAdjustmentDTO[]>#

This method creates shipping method adjustments for an order.

Example#

Code
1const shippingMethodAdjustments = await orderModuleService2  .createOrderShippingMethodAdjustments(3    "123",4    [{5      shipping_method_id: "123",6      code: "50OFF",7      amount: 58    }]9  )

Parameters#

orderIdstring

The order's ID.

dataCreateOrderShippingMethodAdjustmentDTO[]

The order shipping method adjustments to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderShippingMethodAdjustmentDTO[]>

The created shipping method adjustments.

Was this page helpful?