- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createOrUpdateOrderPaymentCollectionWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createOrUpdateOrderPaymentCollectionWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates or updates payment collection for an order. It's used by other order-related workflows, such as createOrderPaymentCollectionWorkflow to update an order's payment collections based on changes made to the order.
You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating or updating payment collections for an order.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
order_id
stringamount
numberOptionalOutput#
PaymentCollectionDTO[]
PaymentCollectionDTO[]
PaymentCollectionDTO[]
PaymentCollectionDTO[]PaymentCollectionDTO
PaymentCollectionDTOThe payment collection details.
PaymentCollectionDTO
PaymentCollectionDTOWas this page helpful?