Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

OrderItem - Order Module Data Models Reference

This documentation provides a reference to the OrderItem data model. It belongs to the Order Module.

idPrimaryKeyModifier<IdProperty>
The ID of the order item.
versionNumberProperty
The version that the order item belongs to.
quantityBigNumberProperty
The quantity of the order item
fulfilled_quantityBigNumberProperty
The fulfilled quantity of the order item
delivered_quantityBigNumberProperty
The delivered quantity of the order item
shipped_quantityBigNumberProperty
The shipped quantity of the order item
return_requested_quantityBigNumberProperty
The quantity requested to be returned.
return_received_quantityBigNumberProperty
The quantity received by a return.
return_dismissed_quantityBigNumberProperty
The quantity dismissed by a return.
written_off_quantityBigNumberProperty
The quantity written off by an order edit.
orderBelongsTo<Order>
The associated order.
itemHasOneWithForeignKey<() => any, undefined>
The associated line item.
unit_priceBigNumberPropertyOptional
The unit price of the order item
compare_at_unit_priceBigNumberPropertyOptional
The original price of the item before a promotion or sale.
metadataJSONPropertyOptional
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
⇧↵