updateExchangeShippingMethodWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateExchangeShippingMethodWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates an exchange's inbound or outbound shipping method. It's used by the Update Inbound Shipping Admin API Route or the Outbound Inbound Shipping Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update an exchange's inbound or outbound shipping method in your custom flow.

Examples#

Steps#

Input#

Output#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

setPricingContext#

This hook is executed before the shipping method is updated. You can consume this hook to return any custom context useful for the prices retrieval of the shipping method's option.

For example, assuming you have the following custom pricing rule:

Code
1{2  "attribute": "location_id",3  "operator": "eq",4  "value": "sloc_123",5}

You can consume the setPricingContext hook to add the location_id context to the prices calculation:

Code
1import { updateExchangeShippingMethodWorkflow } from "@medusajs/medusa/core-flows";2import { StepResponse } from "@medusajs/workflows-sdk";3
4updateExchangeShippingMethodWorkflow.hooks.setPricingContext((5  { order_exchange, order_change, additional_data }, { container }6) => {7  return new StepResponse({8    location_id: "sloc_123", // Special price for in-store purchases9  });10});

The price of the shipping method's option will now be retrieved using the context you return.

Example

Code
1import { updateExchangeShippingMethodWorkflow } from "@medusajs/medusa/core-flows"2
3updateExchangeShippingMethodWorkflow.hooks.setPricingContext(4  (async ({ order_exchange, order_change,5    additional_data }, { container }) => {6    //TODO7  })8)

Input

Handlers consuming this hook accept the following input.