LineItem
Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.
Properties
id
stringRequiredThe line item's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
cart_id
stringRequiredThe ID of the cart that the line item may belongs to.
The details of the cart that the line item may belongs to.
order_id
null | stringRequiredThe ID of the order that the line item may belongs to.
The details of the order that the line item may belongs to.
swap_id
stringRequiredThe ID of the swap that the line item may belong to.
The details of the swap that the line item may belong to.
claim_order_id
stringRequiredThe ID of the claim that the line item may belong to.
The details of the claim that the line item may belong to.
The details of the item's tax lines.
The details of the item's adjustments, which are available when a discount is applied on the item.
title
stringRequiredThe title of the Line Item.
description
null | stringRequiredA more detailed description of the contents of the Line Item.
thumbnail
null | stringRequiredA URL string to a small image of the contents of the Line Item.
is_return
booleanRequiredIs the item being returned
Default: false
is_giftcard
booleanRequiredFlag to indicate if the Line Item is a Gift Card.
Default: false
should_merge
booleanRequiredFlag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.
Default: true
allow_discounts
booleanRequiredFlag to indicate if the Line Item should be included when doing discount calculations.
Default: true
has_shipping
null | booleanRequiredFlag to indicate if the Line Item has fulfillment associated with it.
unit_price
numberRequiredThe price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.
variant_id
null | stringRequiredThe id of the Product Variant contained in the Line Item.
The details of the product variant that this item was created from.
product_id
null | stringRequiredquantity
numberRequiredThe quantity of the content in the Line Item.
fulfilled_quantity
null | numberRequiredThe quantity of the Line Item that has been fulfilled.
returned_quantity
null | numberRequiredThe quantity of the Line Item that has been returned.
shipped_quantity
null | numberRequiredThe quantity of the Line Item that has been shipped.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
includes_tax
booleanRequiredIndicates if the line item unit_price include tax
Default: false
original_item_id
null | stringThe ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.
order_edit_id
null | stringThe ID of the order edit that the item may belong to.
The details of the order edit.
refundable
null | numberThe amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.
subtotal
null | numberThe subtotal of the line item
tax_total
null | numberThe total of tax of the line item
total
null | numberThe total amount of the line item
original_total
null | numberThe original total amount of the line item
original_tax_total
null | numberThe original tax total amount of the line item
discount_total
null | numberThe total of discount of the line item rounded
raw_discount_total
null | numberThe total of discount of the line item
gift_card_total
null | numberThe total of the gift card of the line item
Was this section helpful?