---
updatedAt: 2025-12-18T15:36:56.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# Line item

## Example payload

```json
{
  "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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        FIELD
      </th>

      <th>
        DESCRIPTION
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **canceled**
        boolean
      </td>

      <td>
        Whether or not the item is canceled from the order
      </td>
    </tr>

    <tr>
      <td>
        **canceled_quantity**  
        integer, optional
      </td>

      <td>
        If the line item is only partly canceled, this field will indicate which quantity is canceled.  
        _Note: This field should not be used when a value is sent on **shipped_quantity**_
      </td>
    </tr>

    <tr>
      <td>
        **shipped_quantity**  
        integer, optional
      </td>

      <td>
        Product quantity of the line item within a tracker, in case not all of its fulfilled quantity can fit in a single package.  
        _Note 1: This field is only available in line_items that are nested inside a tracker  
        Note 2: This field should not be used when a value is sent on **canceled_quantity**_
      </td>
    </tr>

    <tr>
      <td>
        **merchant_id**  
        string
      </td>

      <td>
        Unique identifier used by the online retailer for this line_item
      </td>
    </tr>

    <tr>
      <td>
        **title**  
        string
      </td>

      <td>
        Product title
      </td>
    </tr>

    <tr>
      <td>
        **variant_title**  
        string
      </td>

      <td>
        Variant title
      </td>
    </tr>

    <tr>
      <td>
        **name**  
        string
      </td>

      <td>
        Full name of the product
      </td>
    </tr>

    <tr>
      <td>
        **display_name**  
        string
      </td>

      <td>
        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}`
      </td>
    </tr>

    <tr>
      <td>
        **description**  
        string
      </td>

      <td>
        Product description
      </td>
    </tr>

    <tr>
      <td>
        **quantity**  
        integer, optional
      </td>

      <td>
        Product quantity of the line item
      </td>
    </tr>

    <tr>
      <td>
        **requires_shipping**  
        boolean
      </td>

      <td>
        If false, no notification will be sent for this product
      </td>
    </tr>

    <tr>
      <td>
        **sku**  
        string
      </td>

      <td>
        Stock Keeping Unit of the product
      </td>
    </tr>

    <tr>
      <td>
        **thumbnail**  
        object
      </td>

      <td>
        An object formed of the src, width and height keys. Dimensions are in px
      </td>
    </tr>

    <tr>
      <td>
        **price**  
        [MoneyBag](https://developers.shipup.co/reference/address-copy-copy)
      </td>

      <td>
        The total unit price of the line item (incl.tax). Discounts applied.
      </td>
    </tr>

    <tr>
      <td>
        **vat**  
        [MoneyBag](https://developers.shipup.co/reference/address-copy-copy)
      </td>

      <td>
        The VAT the customer paid.
      </td>
    </tr>
  </tbody>
</Table>

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