deleteOrderPaymentCollections - Medusa Core Workflows Reference

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

This workflow deletes one or more payment collections of an order. It's used by the Delete Payment Collection API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a payment collection of an order.

Source Code

Examples#

Steps#

useRemoteQueryStep

throwUnlessStatusIsNotPaid

removeRemoteLinkStep

Workflow Hook

Step conditioned by when

Input#

DeleteOrderPaymentCollectionsInputDeleteOrderPaymentCollectionsInput

The details of the payment collection to delete.

idstring

The ID of the payment collection to delete.

Was this page helpful?