Integration Service

Order Status Service

Part Query Service

Punchout

GetLineItemDetails API Reference

Documentation:

The GetLineItemDetails method(s) will return the current status of an order by supplying any one (1) of the OrderStatusRequest parameters. You can access this method either through SOAP Services or the REST API.

SOAP Method: GetLineItemDetails

REST Request: POST api/OrderStatus/LineDetails

Properties

DataType: ListOfInt64

None.

DataType: ListOfOrderLine
Parameters:
NameDescriptionTypeAdditional information
Quantity

integer

None.
ReferenceId

integer

None.
PartNumber

string

None.
Description

string

None.
Manufacturer

string

None.
ManufacturerId

integer

None.
Notes

Notes

 Collection of LineNote

None.
FacilityId

integer

None.
FacilityName

string

None.
OrderId

integer

None.
FieldValues

Collection of FieldValue

None.
CatalogId

integer

None.
ResearchId

integer

None.
IsExchangeRequired

Indicates that a core replacement is required.

 boolean

None.
Condition

PartCondition

None.
UnitPrice

Get and set the UnitPrice

 decimal number

None.
Tax

Get and set the tax totals for this line

 Taxable

None.
ShipCost

Get and set ship cost for this line

 decimal number

None.
CustomerPo

string

None.
HashValue

Object hash value.

 integer

None.
CustomerLineKey

Work Order number for this line

 string

None.

Request Samples

application/json, text/json

Sample: 
[
  1,
  2
]

application/xml, text/xml

Sample: 
<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

application/x-www-form-urlencoded

Sample: Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Samples

application/json, text/json

Sample: 
[
  {
    "quantity": 1,
    "referenceId": 1,
    "partNumber": "sample string 2",
    "description": "sample string 3",
    "manufacturer": "sample string 4",
    "manufacturerId": 5,
    "notes": [
      {
        "id": 1,
        "date": "2025-10-25T09:19:39.2260185-04:00",
        "userId": 3,
        "userName": "sample string 4",
        "text": "sample string 5"
      },
      {
        "id": 1,
        "date": "2025-10-25T09:19:39.2260185-04:00",
        "userId": 3,
        "userName": "sample string 4",
        "text": "sample string 5"
      }
    ],
    "facilityId": 6,
    "facilityName": "sample string 7",
    "orderId": 8,
    "fieldValues": [
      {
        "fieldUid": "c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce",
        "value": "sample string 2"
      },
      {
        "fieldUid": "c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce",
        "value": "sample string 2"
      }
    ],
    "catalogId": 1,
    "researchId": 1,
    "isExchangeRequired": true,
    "condition": 0,
    "unitPrice": 1.0,
    "tax": {
      "cityTax": 1.0,
      "countyTax": 2.0,
      "districtTax": 3.0,
      "stateTax": 4.0,
      "salesTax": 5.0,
      "hashValue": 6,
      "total": 15.0
    },
    "shipCost": 9.0,
    "customerPo": "sample string 10",
    "hashValue": 11,
    "customerLineKey": "sample string 12"
  },
  {
    "quantity": 1,
    "referenceId": 1,
    "partNumber": "sample string 2",
    "description": "sample string 3",
    "manufacturer": "sample string 4",
    "manufacturerId": 5,
    "notes": [
      {
        "id": 1,
        "date": "2025-10-25T09:19:39.2260185-04:00",
        "userId": 3,
        "userName": "sample string 4",
        "text": "sample string 5"
      },
      {
        "id": 1,
        "date": "2025-10-25T09:19:39.2260185-04:00",
        "userId": 3,
        "userName": "sample string 4",
        "text": "sample string 5"
      }
    ],
    "facilityId": 6,
    "facilityName": "sample string 7",
    "orderId": 8,
    "fieldValues": [
      {
        "fieldUid": "c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce",
        "value": "sample string 2"
      },
      {
        "fieldUid": "c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce",
        "value": "sample string 2"
      }
    ],
    "catalogId": 1,
    "researchId": 1,
    "isExchangeRequired": true,
    "condition": 0,
    "unitPrice": 1.0,
    "tax": {
      "cityTax": 1.0,
      "countyTax": 2.0,
      "districtTax": 3.0,
      "stateTax": 4.0,
      "salesTax": 5.0,
      "hashValue": 6,
      "total": 15.0
    },
    "shipCost": 9.0,
    "customerPo": "sample string 10",
    "hashValue": 11,
    "customerLineKey": "sample string 12"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOrderLine xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <OrderLine>
    <CatalogId>1</CatalogId>
    <Condition>Unknown</Condition>
    <CustomerLineKey>sample string 12</CustomerLineKey>
    <CustomerPo>sample string 10</CustomerPo>
    <Description>sample string 3</Description>
    <FacilityId>6</FacilityId>
    <FacilityName>sample string 7</FacilityName>
    <FieldValues>
      <FieldValue>
        <FieldUid>c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce</FieldUid>
        <Value>sample string 2</Value>
      </FieldValue>
      <FieldValue>
        <FieldUid>c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce</FieldUid>
        <Value>sample string 2</Value>
      </FieldValue>
    </FieldValues>
    <HashValue>11</HashValue>
    <IsExchangeRequired>true</IsExchangeRequired>
    <Manufacturer>sample string 4</Manufacturer>
    <ManufacturerId>5</ManufacturerId>
    <Notes>
      <LineNote>
        <Date>2025-10-25T09:19:39.2260185-04:00</Date>
        <Id>1</Id>
        <Text>sample string 5</Text>
        <UserId>3</UserId>
        <UserName>sample string 4</UserName>
      </LineNote>
      <LineNote>
        <Date>2025-10-25T09:19:39.2260185-04:00</Date>
        <Id>1</Id>
        <Text>sample string 5</Text>
        <UserId>3</UserId>
        <UserName>sample string 4</UserName>
      </LineNote>
    </Notes>
    <OrderId>8</OrderId>
    <PartNumber>sample string 2</PartNumber>
    <Quantity>1</Quantity>
    <ReferenceId>1</ReferenceId>
    <ResearchId>1</ResearchId>
    <ShipCost>9</ShipCost>
    <Tax>
      <CityTax>1</CityTax>
      <CountyTax>2</CountyTax>
      <DistrictTax>3</DistrictTax>
      <HashValue>6</HashValue>
      <SalesTax>5</SalesTax>
      <StateTax>4</StateTax>
    </Tax>
    <UnitPrice>1</UnitPrice>
  </OrderLine>
  <OrderLine>
    <CatalogId>1</CatalogId>
    <Condition>Unknown</Condition>
    <CustomerLineKey>sample string 12</CustomerLineKey>
    <CustomerPo>sample string 10</CustomerPo>
    <Description>sample string 3</Description>
    <FacilityId>6</FacilityId>
    <FacilityName>sample string 7</FacilityName>
    <FieldValues>
      <FieldValue>
        <FieldUid>c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce</FieldUid>
        <Value>sample string 2</Value>
      </FieldValue>
      <FieldValue>
        <FieldUid>c18e6ede-ba3b-4ee9-aa1f-0248027dc1ce</FieldUid>
        <Value>sample string 2</Value>
      </FieldValue>
    </FieldValues>
    <HashValue>11</HashValue>
    <IsExchangeRequired>true</IsExchangeRequired>
    <Manufacturer>sample string 4</Manufacturer>
    <ManufacturerId>5</ManufacturerId>
    <Notes>
      <LineNote>
        <Date>2025-10-25T09:19:39.2260185-04:00</Date>
        <Id>1</Id>
        <Text>sample string 5</Text>
        <UserId>3</UserId>
        <UserName>sample string 4</UserName>
      </LineNote>
      <LineNote>
        <Date>2025-10-25T09:19:39.2260185-04:00</Date>
        <Id>1</Id>
        <Text>sample string 5</Text>
        <UserId>3</UserId>
        <UserName>sample string 4</UserName>
      </LineNote>
    </Notes>
    <OrderId>8</OrderId>
    <PartNumber>sample string 2</PartNumber>
    <Quantity>1</Quantity>
    <ReferenceId>1</ReferenceId>
    <ResearchId>1</ResearchId>
    <ShipCost>9</ShipCost>
    <Tax>
      <CityTax>1</CityTax>
      <CountyTax>2</CountyTax>
      <DistrictTax>3</DistrictTax>
      <HashValue>6</HashValue>
      <SalesTax>5</SalesTax>
      <StateTax>4</StateTax>
    </Tax>
    <UnitPrice>1</UnitPrice>
  </OrderLine>
</ArrayOfOrderLine>

© 2025, PartsSource Inc.