Loading...
Was this page helpful?
This documentation provides a reference to the createCompleteReturnStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step creates a complete return.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createCompleteReturnStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = createCompleteReturnStep({8 "order_id": "order_123"9 })10 }11)
CreateOrderReturnDTO
CreateOrderReturnDTOorder_id
stringreturn_id
stringOptionaldescription
stringOptionalinternal_note
stringOptionalreference
stringOptionalreturn
.reference_id
stringOptionalreference
is return
, the
value is return_123
.metadata
null | Record<string, unknown>Optionallocation_id
stringOptionalitems
object[]Optionalno_notification
booleanOptionalclaim_id
stringOptionalexchange_id
stringOptionalcreated_by
null | stringOptionalReturnDTO
ReturnDTOid
stringstatus
ReturnStatusorder_id
stringitems
OrderReturnItemDTO[]display_id
numbermetadata
null | Record<string, unknown>exchange_id
stringOptionalclaim_id
stringOptionallocation_id
stringOptionalno_notification
booleanOptionalcreated_by
null | stringOptionalcreated_at
string | DateOptionalupdated_at
string | DateOptionaldeleted_at
string | DateOptionalcanceled_at
string | DateOptionalrequested_at
string | DateOptionalreceived_at
string | DateOptional