object LineItem
Fields
| Field | Type | Description |
|---|---|---|
id | String | Public API ID for this identifiable. |
legacy_id | BigInt | Numeric legacy ID for this identifiable; use only where legacy IDs are required. |
sku | String | SKU. SKU matching is case-insensitive and ignores surrounding whitespace. |
partner_line_item_id | String | Partner line item ID from the external store or upstream system. |
product_id | String | DEPRECATED Products should be referenced by sku Public API product ID that identifies the related record. Deprecated; see the deprecation reason for current behavior. |
quantity | Int | Quantity as a whole-unit count. |
price | String | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
product_name | String | Product name for this line item. |
option_title | String | Option title for this line item. |
fulfillment_status | String | Current fulfillment status; use the API status values returned by this field when filtering or updating. |
quantity_pending_fulfillment | Int | Quantity pending fulfillment as a whole-unit count. |
quantity_shipped | Int | Quantity shipped as a whole-unit count. |
warehouse | String | Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference. |
quantity_allocated | Int | Quantity allocated as a whole-unit count. |
backorder_quantity | Int | Backorder quantity as a whole-unit count. |
custom_options | GenericScalar | Arbitrary JSON custom options for the line item; stored as name/value pairs when possible. |
custom_barcode | String | Barcode value for the line item. |
eligible_for_return | Boolean | Whether this line item is eligible to be returned. |
customs_value | String | Declared or purchase value as a decimal monetary amount; distinct from customer-facing price. |
warehouse_id | String | DEPRECATED Use order allocations instead Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects. Deprecated; see the deprecation reason for current behavior. |
locked_to_warehouse_id | String | This field was deprecated on accounts with Multi Warehouse Allocation rules. |
subtotal | String | Customer-facing charge amount as a decimal monetary value in the order currency; distinct from value/customs_value used for declared value. |
barcode | String | Barcode value for the line item. |
created_at | ISODateTime | Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
updated_at | ISODateTime | Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted. |
order_id | String | Public API order ID that identifies the related record. |
shipped_line_item_lots | [ShippedLineItemLot] | List of shipped line item lots for this line item. |
serial_numbers | [LineItemSerialNumber] | List of serial numbers for this line item. |
promotion_discount | String | Promotion discount for this line item. |
product | Product | Product associated with this line item. |
tote_picks | [TotePick] | List of tote picks for this line item. |
Referenced By
- LineItemQuerySpecEdge Type
- Pick Type
- ReturnLineItem Type
- ShipmentLineItem Type
- TotePick Type
- WholesaleLineItem Type
Example
{
"id": "UmVjb3JkOjEyMzQ=",
"legacy_id": 1234,
"sku": "BLUE-TEE-M",
"partner_line_item_id": "SHOPIFY-LINE-1",
"product_id": "TGluZUl0ZW06MTIzNA==",
"quantity": 2,
"price": "19.99",
"product_name": "Blue Tee",
"option_title": "Size: Medium",
"fulfillment_status": "pending",
"quantity_pending_fulfillment": 2,
"quantity_shipped": 2,
"warehouse": "Primary Warehouse",
"quantity_allocated": 2,
"backorder_quantity": 2,
"custom_options": {"reference_id": "REF-100045", "notes": "Fragile"},
"custom_barcode": "012345678905",
"eligible_for_return": true,
"customs_value": "19.99",
"warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"locked_to_warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
"subtotal": "19.99",
"barcode": "012345678905",
"created_at": "2026-07-09T15:30:00Z",
"updated_at": "2026-07-09T15:30:00Z",
"order_id": "TGluZUl0ZW06MTIzNA==",
"shipped_line_item_lots": [[{sku: "BLUE-TEE-M", quantity: 2}]],
"serial_numbers": ["SN-100045", "SN-100046"],
"promotion_discount": "19.99",
"product": {sku: "BLUE-TEE-M", quantity: 2},
"tote_picks": [[{sku: "BLUE-TEE-M", quantity: 2}]]
}