Skip to main content

PurchaseOrderLineItem

A line item, returned with include=line_items on the purchase order read endpoints.

idinteger

The line item's ID. Send it on PATCH to change or remove this line.

Example: 31842
client_line_idstringnullable

The identifier you sent for this line, if any. Unique within the purchase order.

Example: null
skustringnullable

The product's SKU in the merchant's Shopify store.

Example: WIDGET-1
barcodestringnullable

The item's barcode.

Example: null
titlestringnullable

Product title.

Example: Widget
image_urlstringnullable

The product image from the Shopify store.

Example: null
unit_costnumbernullable

Cost per unit, in the purchase order's currency.

Example: 4.5
line_totalnumbernullable

unit_cost times quantity_ordered, before tax.

Example: 45
product_idstringnullable

The Shopify product ID (gid://shopify/Product/<id>). You can look these IDs up with the Shopify Admin GraphQL API.

Example: gid://shopify/Product/1
variant_idstringnullable

The Shopify product variant ID (gid://shopify/ProductVariant/<id>). You can look these IDs up with the Shopify Admin GraphQL API.

Example: gid://shopify/ProductVariant/1
location_idstringnullable

The Shopify location for this line (gid://shopify/Location/<id>).

Example: gid://shopify/Location/1
location_namestringnullable

Name of the line's location.

Example: Main Warehouse
tax_percentstringnullable

Tax rate for the line as a percentage, returned as a string, for example "8.25" for 8.25%.

Example: 0.0
supplier_skustringnullable

The supplier's own code for this item.

Example: null
notestringnullable

A note on this line.

Example: null
variant_titlestringnullable

The variant's title, for example a size or colour.

Example: Default Title
quantity_orderedinteger

Number of units ordered.

Example: 10
inventory_item_idstringnullable

The Shopify inventory item ID (gid://shopify/InventoryItem/<id>). You can look these IDs up with the Shopify Admin GraphQL API.

Example: gid://shopify/InventoryItem/1
positioninteger

Display order of the line on the purchase order.

Example: 1
added_during_receivingboolean

True when the line was added while receiving stock, not when the order was placed.

Example: false
created_atstring<date-time>
Example: 2026-06-01T12:00:00.000Z
updated_atstring<date-time>
Example: 2026-06-01T12:00:00.000Z
PurchaseOrderLineItem
{
  "id": 31842,
  "client_line_id": null,
  "sku": "WIDGET-1",
  "barcode": null,
  "title": "Widget",
  "image_url": null,
  "unit_cost": 4.5,
  "line_total": 45,
  "product_id": "gid://shopify/Product/1",
  "variant_id": "gid://shopify/ProductVariant/1",
  "location_id": "gid://shopify/Location/1",
  "location_name": "Main Warehouse",
  "tax_percent": "0.0",
  "supplier_sku": null,
  "note": null,
  "variant_title": "Default Title",
  "quantity_ordered": 10,
  "inventory_item_id": "gid://shopify/InventoryItem/1",
  "position": 1,
  "added_during_receiving": false,
  "created_at": "2026-06-01T12:00:00.000Z",
  "updated_at": "2026-06-01T12:00:00.000Z"
}