Loading...
Was this page helpful?
This documentation provides a reference to the orderClaimRequestItemReturnWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow requests one or more items to be returned as part of a claim. The items are added to the claim as inbound items. The workflow is used by the Add Inbound Items to Claim Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to request items to be returned as part of a claim in your custom flows.
Source CodeWorkflow hook
Step conditioned by when
View step details
OrderClaimRequestItemReturnWorkflowInputOrderClaimRequestItemReturnWorkflowInputreturn_idstringclaim_idstringitemsCreateReturnItem[]OrderPreviewDTOOrderPreviewDTOidstringversionnumberdisplay_idnumberstatusOrderStatuscurrency_codestringcreated_atstring | Dateupdated_atstring | Dateoriginal_item_totalBigNumberValueoriginal_item_subtotalBigNumberValueoriginal_item_tax_totalBigNumberValueitem_totalBigNumberValueitem_subtotalBigNumberValueitem_tax_totalBigNumberValueoriginal_totalBigNumberValueoriginal_subtotalBigNumberValueoriginal_tax_totalBigNumberValuetotalBigNumberValuesubtotalBigNumberValuetax_totalBigNumberValuediscount_subtotalBigNumberValuediscount_totalBigNumberValuediscount_tax_totalBigNumberValuecredit_line_totalBigNumberValuegift_card_totalBigNumberValuegift_card_tax_totalBigNumberValueshipping_totalBigNumberValueshipping_subtotalBigNumberValueshipping_tax_totalBigNumberValueoriginal_shipping_totalBigNumberValueoriginal_shipping_subtotalBigNumberValueoriginal_shipping_tax_totalBigNumberValueraw_original_item_totalBigNumberRawValueraw_original_item_subtotalBigNumberRawValueraw_original_item_tax_totalBigNumberRawValueraw_item_totalBigNumberRawValueraw_item_subtotalBigNumberRawValueraw_item_tax_totalBigNumberRawValueraw_original_totalBigNumberRawValueraw_original_subtotalBigNumberRawValueraw_original_tax_totalBigNumberRawValueraw_totalBigNumberRawValueraw_subtotalBigNumberRawValueraw_tax_totalBigNumberRawValueraw_discount_totalBigNumberRawValueraw_discount_tax_totalBigNumberRawValueraw_credit_line_totalBigNumberRawValueraw_gift_card_totalBigNumberRawValueraw_gift_card_tax_totalBigNumberRawValueraw_shipping_totalBigNumberRawValueraw_shipping_subtotalBigNumberRawValueraw_shipping_tax_totalBigNumberRawValueraw_original_shipping_totalBigNumberRawValueraw_original_shipping_subtotalBigNumberRawValueraw_original_shipping_tax_totalBigNumberRawValueorder_changeOrderChangeDTOitemsOrderLineItemDTO & object[]shipping_methodsOrderShippingMethodDTO & object[]return_requested_totalnumberregion_idstringOptionalcustomer_idstringOptionalsales_channel_idstringOptionalemailstringOptionalis_draft_orderbooleanOptionalmetadatanull | Record<string, unknown>Optionalcanceled_atstring | DateOptionaldeleted_atstring | DateOptional