Line Item Object

Orders have associated line items, indicating what products are bought for this order along with its quantity.

Line Item Properties

Property

Type

Description

id

string

The ID of the line item.

platform_id

string

The origin platform ID of the line item. You can use this ID to make custom API calls without Rutter to the platform.

product_id

string | null

Rutter ID of the product represented in the Line Item. If the product has been deleted or does not exist in Rutter, the value will be null. This usually happens when an order is placed for a product, but later the merchant deletes that product so the order lose the reference to the ID of that product.

variant_id

string | null

Rutter ID of the product variant represented in the Line Item. If the variant has been deleted or does not exist in Rutter, the value will be null for the same reason above. If the product bought is a default product (meaning there is no variant), variant_id will also be the same as product_id

title

string

Title text of the line item. This should be the same as title of the variant from products endpoint.

price

float

Total cost of all of the products associated with this line item added together. Typically it would be unit_cost times quantity plus other fees, if any.

unit_cost

float

The price per unit of the variant associated with this line item. This should be the same as price of the variant from products endpoint.

iso_currency_code

string

The ISO-4217 currency code of the order

sku

string

The stock keeping unit of the variant associated with this line item. This should be the same as sku field from products endpoint.

quantity

integer

The number of the variant sold for this line_item