A line_item is a product included in an order, with an associated quantity. Line items are split between fulfillments. They are also linked to a tracker once they're shipped.
| FIELD | DESCRIPTION |
|---|---|
| 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) |
Please read the line item configuration guide to fully understand the use cases behind these fields
Thumbnails in CSV:
If you wish to send the thumbnail information in a FTP integration, you'll have to create up to 3 separate columns:
line_item.thumbnail.srcline_item.thumbnail.widthline_item.thumbnail.height