Loading...
Was this page helpful?
Loading...
This documentation provides a reference to the removeClaimShippingMethodWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow removes an inbound (return) or outbound (delivery of new items) shipping method of a claim. It's used by the Remove Inbound Shipping Method, or Remove Outbound Shipping Method Admin API Routes.
You can use this workflow within your customizations or your own custom workflows, allowing you to remove shipping methods from a claim in your own custom flows.
Source CodeWorkflow hook
Step conditioned by when
View step details
DeleteClaimShippingMethodWorkflowInputDeleteClaimShippingMethodWorkflowInputclaim_idstringaction_idstringactions property, whose value is an array of actions.
You can find the action with the name SHIPPING_ADD using its action property, and use the value of
its id property.OrderPreviewDTOOrderPreviewDTOidstringversionnumberdisplay_idnumberstatusOrderStatuscurrency_codestringcreated_atstring | Dateupdated_atstring | Dateoriginal_item_totalBigNumberValueoriginal_item_subtotalBigNumberValueoriginal_item_tax_totalBigNumberValueitem_totalBigNumberValueitem_subtotalBigNumberValueitem_tax_totalBigNumberValueitem_discount_totalBigNumberValueoriginal_totalBigNumberValueoriginal_subtotalBigNumberValueoriginal_tax_totalBigNumberValuetotalBigNumberValuesubtotalBigNumberValuetax_totalBigNumberValuediscount_subtotalBigNumberValuediscount_totalBigNumberValuediscount_tax_totalBigNumberValuecredit_line_totalBigNumberValuegift_card_totalBigNumberValuegift_card_tax_totalBigNumberValueshipping_totalBigNumberValueshipping_subtotalBigNumberValueshipping_tax_totalBigNumberValueshipping_discount_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