Loading...
Was this page helpful?
Loading...
createCompleteReturnStep - Medusa Core Workflows Reference
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)
Input#
CreateOrderReturnDTOCreateOrderReturnDTOThe return to be created.
CreateOrderReturnDTOCreateOrderReturnDTOorder_idstringThe associated order's ID.
order_idstringreturn_idstringOptionalThe associated return's ID.
return_idstringOptionaldescriptionstringOptionalThe description of the action.
descriptionstringOptionalinternal_notestringOptionalThe internal note of the action.
internal_notestringOptionalreferencestringOptionalThe name of the data model the action
references. For example, return.
referencestringOptionalreturn.reference_idstringOptionalThe ID of the record of the data model
specified in reference.
For example, if reference is return, the
value is return_123.
reference_idstringOptionalreference is return, the
value is return_123.metadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>Optionallocation_idstringOptionalThe ID of the location to return the items to.
location_idstringOptionalitemsobject[]OptionalThe items of the return.
itemsobject[]OptionalThe shipping method of the return.
The refund amount of the return.
no_notificationbooleanOptionalWhether the customer should receive notifications related to
updates on the return.
no_notificationbooleanOptionalclaim_idstringOptionalThe associated claim's ID.
claim_idstringOptionalexchange_idstringOptionalThe associated exchange's ID.
exchange_idstringOptionalcreated_bynull | stringOptionalThe id of the user that creates the fulfillment
created_bynull | stringOptionalOutput#
ReturnDTOReturnDTOThe return details.
ReturnDTOReturnDTOidstringThe ID of the return.
idstringstatusReturnStatusThe status of the return.
statusReturnStatusorder_idstringThe associated order's ID.
order_idstringitemsOrderReturnItemDTO[]The items of the return
itemsOrderReturnItemDTO[]display_idnumberThe return's display ID.
display_idnumbermetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>The refund amount of the return.
The raw refund amount of the return.
The associated order.
exchange_idstringOptionalThe associated exchange's ID.
exchange_idstringOptionalThe associated exchange.
claim_idstringOptionalThe associated claim's ID.
claim_idstringOptionalThe associated claim.
location_idstringOptionalThe ID of the location to return the items to.
location_idstringOptionalno_notificationbooleanOptionalWhether the customer should receive notifications related
to updates on the return.
no_notificationbooleanOptionalcreated_bynull | stringOptionalThe id of the user that created the return
created_bynull | stringOptionalThe shipping methods used to receive the returned items.
The return's transactions if refund is required.
created_atstring | DateOptionalThe creation date of the return.
created_atstring | DateOptionalupdated_atstring | DateOptionalThe update date of the return.
updated_atstring | DateOptionaldeleted_atstring | DateOptionalThe deletion date of the return.
deleted_atstring | DateOptionalcanceled_atstring | DateOptionalThe cancelation date of the return.
canceled_atstring | DateOptionalrequested_atstring | DateOptionalThe request date of the return.
requested_atstring | DateOptionalreceived_atstring | DateOptionalThe receival date of the return.
received_atstring | DateOptional