setOrderShippingMethodAdjustments - Order Module Reference

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

This method sets the shipping method adjustments of an order.

Example#

Code
1const shippingMethodAdjustments = await orderModuleService2  .setOrderShippingMethodAdjustments(3    "123",4    [5      {6        shipping_method_id: "123",7        code: "50OFF",8        amount: 59      },10      {11        id: "321",12        amount: 513      }14    ]15  )

Parameters#

orderIdstring

The order's ID.

data(CreateOrderShippingMethodAdjustmentDTO | UpdateOrderShippingMethodAdjustmentDTO)[]

The shipping method adjustments to be created or updated. If an adjustment object has an id property, it's updated. Otherwise, a new adjustment is created.

sharedContextContextOptional

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

Returns#

PromisePromise<OrderShippingMethodAdjustmentDTO[]>

The order's shipping method adjustments.