Menu

UpdateOrderDTO

The attributes to update in the order.

idstringOptional
The ID of the order.
versionnumberOptional
The version of the order.
region_idstringOptional
The associated region's ID.
customer_idstringOptional
The associated customer's ID.
sales_channel_idstringOptional
The associated sales channel's ID.
statusOrderStatusOptional
The status of the order.
is_draft_orderbooleanOptional
Whether the order is a draft order.
itemsCreateOrderLineItemDTO[]Optional
The items of the order.
shipping_addressUpdateOrderAddressDTO | CreateOrderAddressDTOOptional
The shipping address of the order.
billing_addressUpdateOrderAddressDTO | CreateOrderAddressDTOOptional
The billing address of the order.
emailstringOptional
The email of the customer that placed the order.
no_notificationbooleanOptional
Whether the customer should receive notifications about order updates.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
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
⇧↵