Menu

validateOrderCreditLinesStep - Medusa Core Workflows Reference

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

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { validateOrderCreditLinesStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = validateOrderCreditLinesStep({8      "order": {9        "id": "id_DSujkn61lVgGrU",10        "version": 16,11        "display_id": 12,12        "status": "completed",13        "currency_code": "yer",14        "created_at": "2026-02-02T06:17:49.290Z",15        "updated_at": "2025-05-28T04:58:29.923Z",16        "original_item_total": {17          "numeric": 3618        },19        "original_item_subtotal": {20          "numeric": 2421        },22        "original_item_tax_total": {23          "numeric": 3124        },25        "item_total": {26          "numeric": 3527        },28        "item_subtotal": {29          "numeric": 1430        },31        "item_tax_total": {32          "numeric": 033        },34        "original_total": {35          "numeric": 4836        },37        "original_subtotal": {38          "numeric": 3439        },40        "original_tax_total": {41          "numeric": 3942        },43        "total": {44          "numeric": 445        },46        "subtotal": {47          "numeric": 2848        },49        "tax_total": {50          "numeric": 4651        },52        "discount_subtotal": {53          "numeric": 954        },55        "discount_total": {56          "numeric": 4657        },58        "discount_tax_total": {59          "numeric": 960        },61        "gift_card_total": {62          "numeric": 2663        },64        "gift_card_tax_total": {65          "numeric": 4066        },67        "shipping_total": {68          "numeric": 2469        },70        "shipping_subtotal": {71          "numeric": 172        },73        "shipping_tax_total": {74          "numeric": 475        },76        "original_shipping_total": {77          "numeric": 1878        },79        "original_shipping_subtotal": {80          "numeric": 681        },82        "original_shipping_tax_total": {83          "numeric": 4184        }85      },86      "creditLines": [87        "{value}"88      ]89    })90  }91)

Input#

orderOrderDTO
The order details.
idstring
The ID of the order.
versionnumber
The version of the order.
display_idnumber
The order's display ID.
statusOrderStatus
The status of the order.
currency_codestring
The currency of the order
created_atstring | Date
When the order was created.
updated_atstring | Date
When the order was updated.
original_item_totalBigNumberValue
The original item total of the order.
original_item_subtotalBigNumberValue
The original item subtotal of the order.
original_item_tax_totalBigNumberValue
The original item tax total of the order.
item_totalBigNumberValue
The item total of the order.
item_subtotalBigNumberValue
The item subtotal of the order.
item_tax_totalBigNumberValue
The item tax total of the order.
original_totalBigNumberValue
The original total of the order.
original_subtotalBigNumberValue
The original subtotal of the order.
original_tax_totalBigNumberValue
The original tax total of the order.
totalBigNumberValue
The total of the order.
subtotalBigNumberValue
The subtotal of the order. (Excluding taxes)
tax_totalBigNumberValue
The tax total of the order.
discount_subtotalBigNumberValue
The discount subtotal of the order.
discount_totalBigNumberValue
The discount total of the order.
discount_tax_totalBigNumberValue
The discount tax total of the order.
gift_card_totalBigNumberValue
The gift card total of the order.
gift_card_tax_totalBigNumberValue
The gift card tax total of the order.
shipping_totalBigNumberValue
The shipping total of the order.
shipping_subtotalBigNumberValue
The shipping subtotal of the order.
shipping_tax_totalBigNumberValue
The shipping tax total of the order.
original_shipping_totalBigNumberValue
The original shipping total of the order.
original_shipping_subtotalBigNumberValue
The original shipping subtotal of the order.
original_shipping_tax_totalBigNumberValue
The original shipping tax total of the order.
order_changeOrderChangeDTOOptional
The active order change, if any.
region_idstringOptional
The ID of the region the order belongs to.
customer_idstringOptional
The ID of the customer on the order.
sales_channel_idstringOptional
The ID of the sales channel the order belongs to.
emailstringOptional
The email of the order.
shipping_addressOrderAddressDTOOptional
The associated shipping address.
billing_addressOrderAddressDTOOptional
The associated billing address.
itemsOrderLineItemDTO[]Optional
The associated order details / line items.
shipping_methodsOrderShippingMethodDTO[]Optional
The associated shipping methods
transactionsOrderTransactionDTO[]Optional
The tramsactions associated with the order
credit_linesOrderCreditLineDTO[]Optional
The credit lines for an order
summaryOrderSummaryDTOOptional
The summary of the order totals.
is_draft_orderbooleanOptional
Whether the order is a draft order.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
canceled_atstring | DateOptional
When the order was canceled.
creditLinesOmit<CreateOrderCreditLineDTO, "order_id">[]
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵