Get Started
Product
Resources
Tools & SDKs
Framework
Reference

updateReturnsStep - Medusa Core Workflows Reference

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

This step updates one or more returns.

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

Input#

UpdateReturnsStepInputUpdateReturnsStepInput

The returns to update.

idstring

The ID of the return.

location_idnull | stringOptional

The ID of the location to return the items to.

refund_amountBigNumberInputOptional

The refund amount of the return.

no_notificationbooleanOptional

Whether the customer should receive notifications related to updates on the return.

claim_idstringOptional

The associated claim's ID.

exchange_idstringOptional

The associated exchange's ID.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

itemsobject[]Optional

The items of the return.

statusReturnStatusOptional

The return's status.

requested_atDateOptional

Was this page helpful?