- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
addOrderTransactionStep - Medusa Core Workflows Reference
This documentation provides a reference to the addOrderTransactionStep
. It belongs to the @medusajs/medusa/core-flows
package.
This step creates order transactions.
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { addOrderTransactionStep } from "@medusajs/medusa/core-flows"3 4const myWorkflow = createWorkflow(5 "my-workflow",6 () => {7 const data = addOrderTransactionStep({8 "order_id": "order_123",9 "amount": 5,10 "currency_code": "bnd"11 })12 }13)
Input#
AddOrderTransactionStepInput
AddOrderTransactionStepInput
AddOrderTransactionStepInput
AddOrderTransactionStepInputorder_id
stringThe associated order's ID.
order_id
stringamount
BigNumberInputThe amount of the transaction.
amount
BigNumberInputcurrency_code
stringThe currency code of the transaction.
currency_code
stringreturn_id
stringOptionalThe associated return's ID.
return_id
stringOptionalclaim_id
stringOptionalThe associated claim's ID.
claim_id
stringOptionalexchange_id
stringOptionalThe associated exchange's ID.
exchange_id
stringOptionalreference
stringOptionalThe data model this transaction references.
For example, payment
.
reference
stringOptionalpayment
.reference_id
stringOptionalThe ID of the data model's record referenced.
For example, pay_132
.
reference_id
stringOptionalpay_132
.Output#
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...
({ order_id: string | WorkflowData<string>; return_id?: string | WorkflowData<string | undefined> | undefined; claim_id?: string | WorkflowData<string | undefined> | undefined; ... 4 more ...; currency_code: string | WorkflowData<...>; } | (CreateOrderTransactionDTO | WorkflowData<...>)[]) & (CreateOrderTransactionD...Was this page helpful?