This documentation provides a reference to the completeOrderWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow marks one or more orders as completed. It's used by the Complete Cart Admin API Route.
This workflow has a hook that allows you to perform custom actions on the completed orders. For example, you can pass under additional_data
custom data that
allows you to update custom data models linked to the orders.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around order completion.
Source CodeWorkflow hook
Step conditioned by when
View step details
CompleteOrdersWorkflowInput
CompleteOrdersWorkflowInputorderIds
string[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.OrderDTO[]
OrderDTO[]id
stringversion
numberdisplay_id
numberstatus
OrderStatuscurrency_code
stringcreated_at
string | Dateupdated_at
string | Dateoriginal_item_total
BigNumberValueoriginal_item_subtotal
BigNumberValueoriginal_item_tax_total
BigNumberValueitem_total
BigNumberValueitem_subtotal
BigNumberValueitem_tax_total
BigNumberValueoriginal_total
BigNumberValueoriginal_subtotal
BigNumberValueoriginal_tax_total
BigNumberValuetotal
BigNumberValuesubtotal
BigNumberValuetax_total
BigNumberValuediscount_subtotal
BigNumberValuediscount_total
BigNumberValuediscount_tax_total
BigNumberValuegift_card_total
BigNumberValuegift_card_tax_total
BigNumberValueshipping_total
BigNumberValueshipping_subtotal
BigNumberValueshipping_tax_total
BigNumberValueoriginal_shipping_total
BigNumberValueoriginal_shipping_subtotal
BigNumberValueoriginal_shipping_tax_total
BigNumberValueraw_original_item_total
BigNumberRawValueraw_original_item_subtotal
BigNumberRawValueraw_original_item_tax_total
BigNumberRawValueraw_item_total
BigNumberRawValueraw_item_subtotal
BigNumberRawValueraw_item_tax_total
BigNumberRawValueraw_original_total
BigNumberRawValueraw_original_subtotal
BigNumberRawValueraw_original_tax_total
BigNumberRawValueraw_total
BigNumberRawValueraw_subtotal
BigNumberRawValueraw_tax_total
BigNumberRawValueraw_discount_total
BigNumberRawValueraw_discount_tax_total
BigNumberRawValueraw_gift_card_total
BigNumberRawValueraw_gift_card_tax_total
BigNumberRawValueraw_shipping_total
BigNumberRawValueraw_shipping_subtotal
BigNumberRawValueraw_shipping_tax_total
BigNumberRawValueraw_original_shipping_total
BigNumberRawValueraw_original_shipping_subtotal
BigNumberRawValueraw_original_shipping_tax_total
BigNumberRawValueregion_id
stringOptionalcustomer_id
stringOptionalsales_channel_id
stringOptionalemail
stringOptionalis_draft_order
booleanOptionalmetadata
null | Record<string, unknown>Optionalcanceled_at
string | DateOptionalHooks 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.
This hook is executed after the orders are completed. You can consume this hook to perform custom actions on the completed orders.
Handlers consuming this hook accept the following input.
input
inputorders
OrderDTO[]additional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.This section lists the events that are either triggered by the emitEventStep
in the workflow, or by another workflow executed within this workflow.
You can listen to these events in a subscriber, as explained in the Subscribers documentation.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when orders are completed. |
|