createOrderCreditLinesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createOrderCreditLinesWorkflow. It belongs to the @medusajs/medusa/core-flows package.
Examples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
idstringcredit_linesOmit<CreateOrderCreditLineDTO, "order_id">[]
credit_linesOmit<CreateOrderCreditLineDTO, "order_id">[]amountBigNumberInputThe amount of the credit line.
amountBigNumberInputreferencenull | stringThe reference model name that the credit line is generated from
referencenull | stringreference_idnull | stringThe reference model id that the credit line is generated from
reference_idnull | stringmetadatanull | Record<string, unknown>OptionalThe metadata of the order detail
metadatanull | Record<string, unknown>OptionalOutput#
OrderCreditLineDTO[]OrderCreditLineDTO[]
OrderCreditLineDTO[]OrderCreditLineDTO[]idstringThe ID of the order credit line.
idstringorder_idstringThe ID of the order that the credit line belongs to.
order_idstringThe associated order
amountBigNumberValueThe amount of the credit line.
amountBigNumberValuereferencenull | stringThe reference model name that the credit line is generated from
referencenull | stringreference_idnull | stringThe reference model id that the credit line is generated from
reference_idnull | stringmetadatanull | Record<string, unknown>The metadata of the order detail
metadatanull | Record<string, unknown>created_atDateThe date when the order credit line was created.
created_atDateupdated_atDateThe date when the order credit line was last updated.
updated_atDateHooks#
Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
creditLinesCreated#
This step is a hook that you can inject custom functionality into.
Example
Input
Handlers consuming this hook accept the following input.
inputobjectThe input data for the hook.
Was this page helpful?