Skip to main content

PurchaseOrderDetailLineItem

A line item on the flat purchase order write/read response body (PurchaseOrderDetail). Money fields are JSON numbers.

idinteger
Example: 1
client_line_idstringnullable

Caller-supplied idempotency key for this line, used to match a line on a later PATCH.

Example: null
skustringnullable
Example: TSHIRT-BLK-M
barcodestringnullable
Example: null
titlestringnullable
Example: Widget
image_urlstringnullable
Example: null
unit_costnumbernullable
Example: 4.5
line_totalnumbernullable
Example: 45
product_idstringnullable
Example: gid://shopify/Product/1
variant_idstringnullable
Example: gid://shopify/ProductVariant/1
location_idstringnullable
Example: gid://shopify/Location/1
location_namestringnullable
Example: Main Warehouse
tax_percentstringnullable

A tax rate, not an amount, so unlike the money fields it is returned as a string rather than a number. Parse it before doing arithmetic with it.

Example: 0.0
supplier_skustringnullable
Example: null
notestringnullable
Example: null
variant_titlestringnullable
Example: Default Title
quantity_orderedinteger
Example: 10
inventory_item_idstringnullable
Example: gid://shopify/InventoryItem/1
positioninteger
Example: 1
added_during_receivingboolean
Example: false
variant_supplier_cost objectnullable

The supplier's catalog cost for this line item's variant, when known. Null when no supplier catalog match exists.

idinteger
Example: 501
inventory_item_idstringnullable
Example: gid://shopify/InventoryItem/1
product_variant_idintegernullable
Example: 8801234567
supplier_idintegernullable
Example: 42
supplier_skustringnullable
Example: SUP-WIDGET-1
supplier_pricenumbernullable
Example: 4.5
last_costnumbernullable
Example: 4.5
currencystringnullable
Example: USD
is_defaultboolean
Example: true
pack_sizeintegernullable
Example: 1
order_uomstringnullable
Example: each
case_costnumbernullable
Example: 4.5
base_uomstringnullable
Example: each
sold_bystringnullable
Example: each
created_atstring<date-time>
Example: 2026-06-01T12:00:00.000Z
updated_atstring<date-time>
Example: 2026-06-01T12:00:00.000Z
PurchaseOrderDetailLineItem
{
  "id": 1,
  "client_line_id": null,
  "sku": "TSHIRT-BLK-M",
  "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,
  "variant_supplier_cost": {
    "id": 501,
    "inventory_item_id": "gid://shopify/InventoryItem/1",
    "product_variant_id": 8801234567,
    "supplier_id": 42,
    "supplier_sku": "SUP-WIDGET-1",
    "supplier_price": 4.5,
    "last_cost": 4.5,
    "currency": "USD",
    "is_default": true,
    "pack_size": 1,
    "order_uom": "each",
    "case_cost": 4.5,
    "base_uom": "each",
    "sold_by": "each"
  },
  "created_at": "2026-06-01T12:00:00.000Z",
  "updated_at": "2026-06-01T12:00:00.000Z"
}