GET purchase-orders/{purchaseOrderId}/lines/{lineId}
Returns a single Purchase Order line by ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| purchaseOrderId | The ID of the Purchase Order | integer | Required |
| lineId | The ID of the Purchase Order line | integer | Required |
Body Parameters
None.
Response Information
Resource Description
Returns a single Purchase Order line by ID.
PurchaseOrderLineModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderLineID | Purchase Order Line ID | integer | None. |
| ProductID | Product ID associated with the line | integer | None. |
| ProductSKU | Product SKU associated with the line | string | None. |
| SupplierSKU | The SKU the supplier uses to identify the product, taken from the product's supplier link for this purchase order's supplier. Null when the product has no supplier SKU set for that supplier. | string | None. |
| QtyOrdered | Number of units ordered | integer | None. |
| QtyReceived | Number of units received | integer | None. |
| PurchaseOrderDetailsStatus | PurchaseOrderDetailsStatusEnum | None. | |
| SinglePrice | decimal number | None. | |
| TaxRate | The Tax Rate for the purchase order line item | decimal number | None. |
| LineVat | decimal number | None. | |
| LineTotal | decimal number | None. | |
| DeliveryStatusID | integer | None. | |
| DeliveryStatus | string | None. | |
| QtyWrittenOff | decimal number | None. | |
| CartonQty | integer | None. | |
| AddedByUserID | integer | None. | |
| BookedInByUserID | integer | None. | |
| TotalUnitsOrdered | integer | None. | |
| TotalUnitsReceived | integer | None. | |
| TotalUnitsWrittenOff | integer | None. | |
| DateReceived | The date the purchase order was recieved. | date | None. |
| LineNotes | Any notes added to the purchase order line. | string | None. |
Response Formats
application/json, text/json
Sample:
{
"PurchaseOrderLineID": 789,
"ProductSKU": "ABC",
"SupplierSKU": "SUP-ABC",
"QtyOrdered": 10,
"QtyReceived": 0,
"PurchaseOrderDetailsStatus": "AwaitingProduct",
"SinglePrice": 1.99,
"LineVat": 1.78,
"LineTotal": 19.99,
"DeliveryStatusID": 1,
"DeliveryStatus": "Pending",
"QtyWrittenOff": 0.0,
"CartonQty": 10,
"AddedByUserID": 1,
"BookedInByUserID": 1,
"TotalUnitsOrdered": 10,
"TotalUnitsReceived": 0,
"TotalUnitsWrittenOff": 0,
"DateReceived": "2026-10-24T18:06:03.1202157Z"
}
application/xml, text/xml
Sample:
<PurchaseOrderLineModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PurchaseOrderLineID>789</PurchaseOrderLineID> <ProductID xsi:nil="true" /> <ProductSKU>ABC</ProductSKU> <SupplierSKU>SUP-ABC</SupplierSKU> <QtyOrdered>10</QtyOrdered> <QtyReceived>0</QtyReceived> <PurchaseOrderDetailsStatus>AwaitingProduct</PurchaseOrderDetailsStatus> <SinglePrice>1.99</SinglePrice> <TaxRate xsi:nil="true" /> <LineVat>1.78</LineVat> <LineTotal>19.99</LineTotal> <DeliveryStatusID>1</DeliveryStatusID> <DeliveryStatus>Pending</DeliveryStatus> <QtyWrittenOff>0</QtyWrittenOff> <CartonQty>10</CartonQty> <AddedByUserID>1</AddedByUserID> <BookedInByUserID>1</BookedInByUserID> <TotalUnitsOrdered>10</TotalUnitsOrdered> <TotalUnitsReceived>0</TotalUnitsReceived> <TotalUnitsWrittenOff>0</TotalUnitsWrittenOff> <DateReceived>2026-10-24T18:06:03.1202157Z</DateReceived> </PurchaseOrderLineModel>