Menu

CreateOrderDTO

The data of the order to be created.

region_idstringOptional
The associated region's ID.
customer_idstringOptional
The associated customer's ID.
sales_channel_idstringOptional
The associated sales channel's ID.
statusstringOptional
The status of the order.
emailstringOptional
The email of the customer that placed the order.
currency_codestringOptional
The currency code of the order.
shipping_address_idstringOptional
The associated shipping address's ID.
billing_address_idstringOptional
The associated billing address's ID.
shipping_addressUpdateOrderAddressDTO | CreateOrderAddressDTOOptional
The shipping address of the order.
billing_addressUpdateOrderAddressDTO | CreateOrderAddressDTOOptional
The billing address of the order.
no_notificationbooleanOptional
Whether the customer should receive notifications about order updates.
itemsCreateOrderLineItemDTO[]Optional
The items of the order.
shipping_methodsOmit<CreateOrderShippingMethodDTO, "order_id">[]Optional
The shipping methods of the order.
credit_linesOrderCreditLineDTO[]Optional
The credit lines of the order.
transactionsOmit<CreateOrderTransactionDTO, "order_id">[]Optional
The transactions of the order.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
promo_codesstring[]Optional
The promo codes of the order.
Was this page helpful?
Edit this page
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
⇧↵