class Falsify::OrderLineItem

An individual item in an Order.

Required Fields:

Attributes

discount_allocations[RW]

An ordered list of amounts allocated by discount applications. Each discount allocation is associated to a particular discount application. @return [Array<DiscountAllocation>]

fulfillable_quantity[RW]

The amount available to fulfill, calculated as follows: `quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity`. @return [String]

fulfillment_service[RW]

The service provider that's fulfilling the item. Valid values: “manual”, or the name of the provider, such as “amazon” or “shipwire”. @return [String]

gift_card[RW]

Whether the item is a gift card. If true, then the item is not taxed or considered for shipping charges. @return [Boolean]

grams[RW]

The weight of the item in grams. @return [String]

name[RW]

The name of the product variant. @return [String]

price[RW]

The price of the item before discounts have been applied in the shop currency. @return [String]

price_set[RW]

The price of the line item in shop and presentment currencies. @return [PriceSet]

product_id[RW]

The ID of the product that the line item belongs to. Can be null if the original product associated with the order is deleted at a later date. @return [String]

properties[RW]

An array of custom information for the item that has been added to the cart. Often used to provide product customization options. For more information, see [Get customization information for products with line item properties](help.shopify.com/en/themes/customization/products/features/get-customization-information-for-products). @return [Array<Hash>]

quantity[RW]

The number of items that were purchased. @return [Integer]

requires_shipping[RW]

Whether the item requires shipping. @return [Boolean]

shopify_id[RW]

The ID of the line item. @return [String]

sku[RW]

The item's SKU (stock keeping unit). @return [String]

tax_lines[RW]

A list of tax line objects, each of which details a tax applied to the item. @return [Array<TaxLine>]

taxable[RW]

Whether the item was taxable. @return [Boolean]

tip_payment_gateway[RW]

The payment gateway used to tender the tip, such as shopify_payments. Present only on tips. @return [String]

tip_payment_method[RW]

The payment method used to tender the tip, such as Visa. Present only on tips. @return [String]

title[RW]

The title of the product. @return [String]

total_discount[RW]

The total discount amount applied to this line item in the shop currency. This value is not subtracted in the line item price. @return [String]

total_discount_set[RW]

The total discount applied to the line item in shop and presentment currencies. @return [PriceSet]

variant_id[RW]

The ID of the product variant. @return [String]

variant_title[RW]

The title of the product variant. @return [String]

vendor[RW]

The name of the item's supplier. @return [String]