Order item

Order item object represents an order line.

List of available attributes

• amount
• has_item_discount
• discount
• note
• original_price
• product_image?
• product_image
• product_is_variant
• product_name
• product_variant_description
• product_variant_descriptions
• price
• quantity
• subtotal_amount
• tax_amount
• tax_rate

amount

Returns total cost of the order row after-tax.

has_item_discount

Returns true if a discount is applied to the order item. Returns false otherwise.

discount

Returns a Discount object if discount is applied to the order item.

note

Returns additional notes.

original_price

Returns the original price of the product.

product_image?

Returns true if the product has an image. Returns false otherwise.

product_image

Returns Image object of the product image.

product_is_variant

Returns true if the product is a variant. Returns false otherwise.

product_name

Returns parent product name. If the product is a parent product, then returns its name.

product_variant_description

Returns product variant name in human readable format based on locale (e.g. "Color: Blue, Size: M"). Returns null if the product does not have a description.

product_variant_descriptions

{{ order_item.product_variant_descriptions }}

[
  {
    "name": "Color",
    "value": "Blue"
  },
  {
    "name": "Size",
    "value": "M"
  }
]

price

Returns the product price after applying discounts.

quantity

Returns the quantity of items.

subtotal_amount

Returns total sum of order row before tax and after applying discounts.

tax_amount

Returns total tax amount of order row.

tax_rate

Returns tax rate of order row.