Line item

Example payload

{
  "object": "line_item",
  "id": 12347,
  "canceled": null,
  "canceled_quantity": null,
  "created_at": 1570906800,
  "custom_variables": null,
  "description": null,
  "display_name": "Product title",
  "merchant_id": "LINE_ITEM_M_UNFULFILLED_ID_3",
  "name": null,
  "quantity": null,
  "requires_shipping": null,
  "shipped_quantity": null,
  "sku": "LINE_ITEM_UNFULFILLED_SKU_3",
  "thumbnail": {
    "src": "https://imgurl.com/foo.jpg",
    "width": "300",
    "height": "100"
  },
  "title": "Product title",
  "updated_at": 1570906800,
  "variant_title": null,
  "price": {
    "merchant_money": { "amount": "11.00", "currency_code": "EUR" },
    "presentment_money": { "amount": "10.00", "currency_code": "USD" }
  },
  "vat": {
    "merchant_money": { "amount": "1.83", "currency_code": "EUR" },
    "presentment_money": { "amount": "1.67", "currency_code": "USD" }
  },
}

Attributes

FIELD	DESCRIPTION
canceled boolean	Whether or not the item is canceled from the order
canceled_quantity integer	If the line item is only partly canceled, this field will indicate which quantity is canceled.
merchant_id string	Unique identifier used by the online retailer for this line_item
title string	Product title
variant_title string	Variant title
name string	Full name of the product
display_name string	The name computed from the name/title/variant_title field. If name exists, it will be used in priority. If it does not, the display_name will return `{title} - {variant_title}`
description string	Product description
quantity integer, optional	Product quantity of the line item
requires_shipping boolean	If false, no notification will be sent for this product
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.
sku string	Stock Keeping Unit of the product
thumbnail object	An object formed of the src, width and height keys. Dimensions are in px
price MoneyBag	The total unit price of the line item (incl.tax). Discounts applied.
vat MoneyBag	The VAT the customer paid.

Disclaimer

The objects price and vat are being currently implemented, you can already send the information to us, but you won't be able to use it right away. Our team will keep you posted as soon as we have more info about it.