Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

cancelOrderFulfillmentValidateOrder - Medusa Core Workflows Reference

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

This step validates that an order fulfillment can be canceled. If the fulfillment doesn't exist, or it has already been shipped, the step throws an error.

Note: You can retrieve an order and fulfillment details using Query, or useQueryGraphStep.

Example#

Code
1const data = cancelOrderFulfillmentValidateOrder({2  order: {3    id: "order_123",4    fulfillments: [5      {6        id: "ful_123",7        // other fulfillment details...8      }9    ]10    // other order details...11  },12  input: {13    order_id: "order_123",14    fulfillment_id: "ful_123"15  }16})

Input#

CancelOrderFulfillmentValidateOrderStepCancelOrderFulfillmentValidateOrderStep
The data to validate the order fulfillment cancelation.
orderOrderDTO & object
The order to cancel the fulfillment for.
inputCancelOrderFulfillmentWorkflowInput
The cancelation details.
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
⇧↵