Get Started
Product
Resources
Tools & SDKs
Framework
Reference

cancelOrderReturnStep - Medusa Core Workflows Reference

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

This step cancels a return.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { cancelOrderReturnStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = cancelOrderReturnStep({8      "order_id": "order_123",9      "return_id": "{value}"10    })11  }12)

Input#

CancelOrderReturnDTOCancelOrderReturnDTO

The details of the return cancelation.

order_idstring

The associated order's ID.

return_idstring

The return's ID.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange's ID.

descriptionstringOptional

The description of the action.

internal_notestringOptional

The internal note of the action.

referencestringOptional

The name of the data model the action references. For example, return.

reference_idstringOptional

The ID of the record of the data model specified in reference. For example, if reference is return, the value is return_123.

created_bynull | stringOptional

The user or customer that created this action.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

canceled_bystringOptional

The ID of the user canceling the return.

Was this page helpful?