Loading...
Was this page helpful?
Loading...
updateOrdersStep - Medusa Core Workflows Reference
This documentation provides a reference to the updateOrdersStep. It belongs to the @medusajs/medusa/core-flows package.
This step updates orders matching the specified filters.
Example#
Input#
UpdateOrdersStepInputUpdateOrdersStepInputThe details of updating the orders.
UpdateOrdersStepInputUpdateOrdersStepInputselectorFilterableOrderPropsThe filters to select the orders to update.
selectorFilterableOrderPropsupdateUpdateOrderDTOThe data to update in the orders.
updateUpdateOrderDTOOutput#
OrderDTO[]OrderDTO[]
OrderDTO[]OrderDTO[]idstringThe ID of the order.
idstringversionnumberThe version of the order.
versionnumberdisplay_idnumberThe order's display ID.
display_idnumberstatusOrderStatusThe status of the order.
statusOrderStatuscurrency_codestringThe currency of the order
currency_codestringcreated_atstring | DateWhen the order was created.
created_atstring | Dateupdated_atstring | DateWhen the order was updated.
updated_atstring | Dateoriginal_item_totalBigNumberValueThe original item total of the order.
original_item_totalBigNumberValueoriginal_item_subtotalBigNumberValueThe original item subtotal of the order.
original_item_subtotalBigNumberValueoriginal_item_tax_totalBigNumberValueThe original item tax total of the order.
original_item_tax_totalBigNumberValueitem_totalBigNumberValueThe item total of the order.
item_totalBigNumberValueitem_subtotalBigNumberValueThe item subtotal of the order.
item_subtotalBigNumberValueitem_tax_totalBigNumberValueThe item tax total of the order.
item_tax_totalBigNumberValueoriginal_totalBigNumberValueThe original total of the order.
original_totalBigNumberValueoriginal_subtotalBigNumberValueThe original subtotal of the order.
original_subtotalBigNumberValueoriginal_tax_totalBigNumberValueThe original tax total of the order.
original_tax_totalBigNumberValuetotalBigNumberValueThe total of the order.
totalBigNumberValuesubtotalBigNumberValueThe subtotal of the order. (Excluding taxes)
subtotalBigNumberValuetax_totalBigNumberValueThe tax total of the order.
tax_totalBigNumberValuediscount_subtotalBigNumberValueThe discount subtotal of the order.
discount_subtotalBigNumberValuediscount_totalBigNumberValueThe discount total of the order.
discount_totalBigNumberValuediscount_tax_totalBigNumberValueThe discount tax total of the order.
discount_tax_totalBigNumberValuegift_card_totalBigNumberValueThe gift card total of the order.
gift_card_totalBigNumberValuegift_card_tax_totalBigNumberValueThe gift card tax total of the order.
gift_card_tax_totalBigNumberValueshipping_totalBigNumberValueThe shipping total of the order.
shipping_totalBigNumberValueshipping_subtotalBigNumberValueThe shipping subtotal of the order.
shipping_subtotalBigNumberValueshipping_tax_totalBigNumberValueThe shipping tax total of the order.
shipping_tax_totalBigNumberValueoriginal_shipping_totalBigNumberValueThe original shipping total of the order.
original_shipping_totalBigNumberValueoriginal_shipping_subtotalBigNumberValueThe original shipping subtotal of the order.
original_shipping_subtotalBigNumberValueoriginal_shipping_tax_totalBigNumberValueThe original shipping tax total of the order.
original_shipping_tax_totalBigNumberValueraw_original_item_totalBigNumberRawValueThe raw original item total of the order.
raw_original_item_totalBigNumberRawValueraw_original_item_subtotalBigNumberRawValueThe raw original item subtotal of the order.
raw_original_item_subtotalBigNumberRawValueraw_original_item_tax_totalBigNumberRawValueThe raw original item tax total of the order.
raw_original_item_tax_totalBigNumberRawValueraw_item_totalBigNumberRawValueThe raw item total of the order.
raw_item_totalBigNumberRawValueraw_item_subtotalBigNumberRawValueThe raw item subtotal of the order.
raw_item_subtotalBigNumberRawValueraw_item_tax_totalBigNumberRawValueThe raw item tax total of the order.
raw_item_tax_totalBigNumberRawValueraw_original_totalBigNumberRawValueThe raw original total of the order.
raw_original_totalBigNumberRawValueraw_original_subtotalBigNumberRawValueThe raw original subtotal of the order.
raw_original_subtotalBigNumberRawValueraw_original_tax_totalBigNumberRawValueThe raw original tax total of the order.
raw_original_tax_totalBigNumberRawValueraw_totalBigNumberRawValueThe raw total of the order.
raw_totalBigNumberRawValueraw_subtotalBigNumberRawValueThe raw subtotal of the order. (Excluding taxes)
raw_subtotalBigNumberRawValueraw_tax_totalBigNumberRawValueThe raw tax total of the order.
raw_tax_totalBigNumberRawValueraw_discount_totalBigNumberRawValueThe raw discount total of the order.
raw_discount_totalBigNumberRawValueraw_discount_tax_totalBigNumberRawValueThe raw discount tax total of the order.
raw_discount_tax_totalBigNumberRawValueraw_gift_card_totalBigNumberRawValueThe raw gift card total of the order.
raw_gift_card_totalBigNumberRawValueraw_gift_card_tax_totalBigNumberRawValueThe raw gift card tax total of the order.
raw_gift_card_tax_totalBigNumberRawValueraw_shipping_totalBigNumberRawValueThe raw shipping total of the order.
raw_shipping_totalBigNumberRawValueraw_shipping_subtotalBigNumberRawValueThe raw shipping subtotal of the order.
raw_shipping_subtotalBigNumberRawValueraw_shipping_tax_totalBigNumberRawValueThe raw shipping tax total of the order.
raw_shipping_tax_totalBigNumberRawValueraw_original_shipping_totalBigNumberRawValueThe raw original shipping total of the order.
raw_original_shipping_totalBigNumberRawValueraw_original_shipping_subtotalBigNumberRawValueThe raw original shipping subtotal of the order.
raw_original_shipping_subtotalBigNumberRawValueraw_original_shipping_tax_totalBigNumberRawValueThe raw original shipping tax total of the order.
raw_original_shipping_tax_totalBigNumberRawValueThe active order change, if any.
region_idstringOptionalThe ID of the region the order belongs to.
region_idstringOptionalcustomer_idstringOptionalThe ID of the customer on the order.
customer_idstringOptionalsales_channel_idstringOptionalThe ID of the sales channel the order belongs to.
sales_channel_idstringOptionalemailstringOptionalThe email of the order.
emailstringOptionalThe associated shipping address.
The associated billing address.
The associated order details / line items.
The associated shipping methods
The tramsactions associated with the order
The credit lines for an order
The summary of the order totals.
is_draft_orderbooleanOptionalWhether the order is a draft order.
is_draft_orderbooleanOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>Optionalcanceled_atstring | DateOptionalWhen the order was canceled.
canceled_atstring | DateOptional