Example line item object
{
  "object": "line_item",
  "id": 63819516,
  "canceled": false,
  "canceled_quantity": 0,
  "custom_variables": {},
  "description": "The classical Ipod",
  "name": "Ipod Nano - Green",
  "merchant_id": "404142",
  "quantity": 1,
  "requires_shipping": true,
  "sku": "3700719011997",
  "shipped_quantity": 1,  
  "thumbnail": {
   "src": "https://imgur.com/ipodnanogreen",
   "height": 120,
   "width": 50
  },
  "title": "Ipod Nano",
  "variant_title": "Green",
  "created_at": 1564683016,
  "updated_at": 1564683792
}

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

id
integer

Unique identifier of the line item

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. 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)

custom_variables
object

Object containing custom variables. Those variables can be reused to customize or add logic in the notifications

description
string

Product description

merchant_id
string

Unique identifier used by the online retailer for the line item

name
string

Full name of the product

quantity
integer

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.

shipped_quantity
integer

(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 this quantity can fit in a single package. This field is smaller than or equal to quantity. (See use case)

requires_shipping
boolean

If false, Shipup won't consider that this line item needs to be shipped and tracked. Defaults to true. (See use case)

sku
string

Sku of the product

thumbnail
object

An object formed of the src, width and height keys. Dimensions are in px

title
string

Product title

variant_title
string

Product variant title

created_at
datetime

Time at which the line item was imported into Shipup

updated_at
datetime

Time at which the line item was last updated

📘

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.src
  • line_item.thumbnail.width
  • line_item.thumbnail.height