Skip to main content
Skip to main content

Order Item

In this document, you’ll learn about the order item and the general details it holds.

OrderItem Data Model

Each item in an order is represented by the OrderItem data model. It holds details related to the quantity of the item and the underlying product details.


Order Item Quantity

The OrderItem data model has the following quantity attributes:

  • quantity: The quantity ordered.
  • fulfilled_quantity: The quantity that’s been fulfilled.
  • shipped_quantity: The quantity that’s been shipped.
  • return_requested_quantity: The quantity requested to be returned, but hasn’t been received yet.
  • return_received_quantity: The quantity that’s been received from the customer due to a return request.
  • return_dismissed_quantity: The quantity that’s been received from the customer due to a return request, but the items are damaged.
  • written_off_quantity: The quantity removed from the originally ordered quantity.

Item’s Product Details

The details of the purchased products are represented by the LineItem data model. Not only does a line item hold the details of the product, but also details related to its price, adjustments due to promotions, and taxes.

Note

The LineItem data model is similar to the Cart Module’s LineItem data model. So, when using both modules, the data can be copied between the modules as-is.

Was this section helpful?