CreateOrderLineItemDTO

The data of the line item to create.

titlestring
The title of the line item.
The quantity of the line item.
unit_priceBigNumberInput
The unit price of the line item.
subtitlestringOptional
The subtitle of the line item.
thumbnailstringOptional
The thumbnail of the line item.
order_idstringOptional
The associated order's ID.
product_idstringOptional
The associated product's ID.
product_titlestringOptional
The product title of the line item.
product_descriptionstringOptional
The product description of the line item.
product_subtitlestringOptional
The product subtitle of the line item.
product_typestringOptional
The product type of the line item.
product_collectionstringOptional
The product collection of the line item.
product_handlestringOptional
The product handle of the line item.
variant_idstringOptional
The associated variant's ID.
variant_skustringOptional
The variant sku of the line item.
variant_barcodestringOptional
The variant barcode of the line item.
variant_titlestringOptional
The variant title of the line item.
variant_option_valuesRecord<string, unknown>Optional
The variant option values of the line item.
requires_shippingbooleanOptional
Whether the line item requires shipping.
is_discountablebooleanOptional
Whether the line item is discountable.
is_tax_inclusivebooleanOptional
Whether the line item is tax inclusive.
compare_at_unit_priceBigNumberInputOptional
The compare-at unit price of the line item.
tax_linesCreateOrderTaxLineDTO[]Optional
The tax lines of the line item.
adjustmentsCreateOrderAdjustmentDTO[]Optional
The adjustments of the line item.
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
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