createOrderCreditLinesWorkflow - Medusa Core Workflows Reference

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

Source Code

Examples#

Steps#

useQueryGraphStep

validateOrderCreditLinesStep

createOrderChangeStep

createOrderChangeActionsWorkflow

useQueryGraphStep

creditLinesCreated

Workflow hook

Step conditioned by when

View step details

Input#

idstring

credit_linesOmit<CreateOrderCreditLineDTO, "order_id">[]

Output#

OrderCreditLineDTO[]OrderCreditLineDTO[]

idstring

The ID of the order credit line.

order_idstring

The ID of the order that the credit line belongs to.

orderOrderDTO

The associated order

amountBigNumberValue

The amount of the credit line.

referencenull | string

The reference model name that the credit line is generated from

reference_idnull | string

The reference model id that the credit line is generated from

metadatanull | Record<string, unknown>

The metadata of the order detail

created_atDate

The date when the order credit line was created.

updated_atDate

The date when the order credit line was last updated.

Hooks#

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

Code
1import { createOrderCreditLinesWorkflow } from "@medusajs/medusa/core-flows"2
3createOrderCreditLinesWorkflow.hooks.creditLinesCreated(4  (async ({}, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

inputobject

The input data for the hook.