The line item object

merchant_id string, required

Unique identifier used by the online retailer for this line_item

title
string, optional

Product title

variant_title
string, optional

Variant title

name
string, optional

Full name of the product

description
string, optional

Product description

quantity
integer, optional

Product quantity of the line item in the fulfillment. This field must not change. If part of the quantity of the line item is canceled, please use canceled_quantity field.

requires_shipping
boolean, optional

If false, no notification will be sent for this product. Defaults to true

shipped_quantity
integer, optional

(This field is only available in line_items that are nested inside a tracker)
Product quantity of the line item within a tracker, in case not all of its fulfilled quantity can fit in a single package. This field must be smaller than or equal to quantity. (See use case)

sku
string, optional

Stock Keeping Unit of the product

thumbnail
object, optional

An object formed of the src, width and height keys. Dimensions are in px
{ "src": "https://*.jpg", "width": "400", "height": "400" }

canceled
boolean, optional

Whether or not the item is canceled from the order

canceled_quantity
integer, optional

If the line item is only partly canceled, this field will indicate which quantity is canceled. The quantity field must remain unchanged. If the canceled quantity evolves, this field must change. If the canceled_quantity is greater than or equal to the quantity, the canceled field will be forced to true. (See use case)

price
string (ex: "20.00" for 20€)

The unit price (incl. tax, incl. discount) of the line item, in the same currency as order_details.currency_code.

vat_amount
string (ex: "20.00" for 20€)

The VAT for a single item of this line, in the same currency as order_details.currency_code.

merchant_price
string (ex: "20.00" for 20€)

Optional. The unit price (incl. tax, incl. discount) of the line item, in the same currency as order_details.merchant_currency_code

merchant_vat_amount
string (ex: "20.00" for 20€)

Optional. The VAT for a single item of this line, in the same currency as order_details.merchant_currency_code