Integration Service

Order Status Service

Part Query Service

Punchout

GetOrderStatusHistory API Reference

Documentation:

The GetOrderStatusHistory 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: GetOrderStatusHistory

REST Request: POST api/OrderStatus/History

Properties

DataType: OrderStatusRequest

NameDescriptionTypeAdditional information
LineReferenceId

integer

None.
OrderReferenceId

integer

None.
PurchaseReferenceId

integer

None.
FacilityId

integer

None.
StartDate

date

None.
EndDate

date

None.
CustomerPO

string

None.
DataType: OrderStatusResponse
Parameters:
NameDescriptionTypeAdditional information
StatusList

Collection of LineStatusResponse

None.

Request Samples

application/json, text/json

Sample: 
{
  "lineReferenceId": 1,
  "orderReferenceId": 1,
  "purchaseReferenceId": 1,
  "facilityId": 1,
  "startDate": "2025-10-25T09:25:55.4155643-04:00",
  "endDate": "2025-10-25T09:25:55.4155643-04:00",
  "customerPO": "sample string 1"
}

application/xml, text/xml

Sample: 
<OrderStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <CustomerPO>sample string 1</CustomerPO>
  <EndDate>2025-10-25T09:25:55.4155643-04:00</EndDate>
  <FacilityId>1</FacilityId>
  <LineReferenceId>1</LineReferenceId>
  <OrderReferenceId>1</OrderReferenceId>
  <PurchaseReferenceId>1</PurchaseReferenceId>
  <StartDate>2025-10-25T09:25:55.4155643-04:00</StartDate>
</OrderStatusRequest>

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 'OrderStatusRequest'.

Response Samples

application/json, text/json

Sample: 
{
  "statusList": [
    {
      "referenceId": 1,
      "currentStatusId": 1,
      "oldStatusId": 2,
      "oldStatus": "sample string 3",
      "newStatusId": 4,
      "newStatus": "sample string 5",
      "backorderEta": "2025-10-25T09:25:55.4155643-04:00",
      "backorderCode": "sample string 6",
      "userId": 7,
      "name": "sample string 8",
      "timestamp": "2025-10-25T09:25:55.4155643-04:00",
      "customerPO": "sample string 10"
    },
    {
      "referenceId": 1,
      "currentStatusId": 1,
      "oldStatusId": 2,
      "oldStatus": "sample string 3",
      "newStatusId": 4,
      "newStatus": "sample string 5",
      "backorderEta": "2025-10-25T09:25:55.4155643-04:00",
      "backorderCode": "sample string 6",
      "userId": 7,
      "name": "sample string 8",
      "timestamp": "2025-10-25T09:25:55.4155643-04:00",
      "customerPO": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample: 
<OrderStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <StatusList>
    <LineStatusResponse>
      <BackorderCode>sample string 6</BackorderCode>
      <BackorderEta>2025-10-25T09:25:55.4155643-04:00</BackorderEta>
      <CurrentStatusId>1</CurrentStatusId>
      <CustomerPO>sample string 10</CustomerPO>
      <Name>sample string 8</Name>
      <NewStatus>sample string 5</NewStatus>
      <NewStatusId>4</NewStatusId>
      <OldStatus>sample string 3</OldStatus>
      <OldStatusId>2</OldStatusId>
      <ReferenceId>1</ReferenceId>
      <Timestamp>2025-10-25T09:25:55.4155643-04:00</Timestamp>
      <UserId>7</UserId>
    </LineStatusResponse>
    <LineStatusResponse>
      <BackorderCode>sample string 6</BackorderCode>
      <BackorderEta>2025-10-25T09:25:55.4155643-04:00</BackorderEta>
      <CurrentStatusId>1</CurrentStatusId>
      <CustomerPO>sample string 10</CustomerPO>
      <Name>sample string 8</Name>
      <NewStatus>sample string 5</NewStatus>
      <NewStatusId>4</NewStatusId>
      <OldStatus>sample string 3</OldStatus>
      <OldStatusId>2</OldStatusId>
      <ReferenceId>1</ReferenceId>
      <Timestamp>2025-10-25T09:25:55.4155643-04:00</Timestamp>
      <UserId>7</UserId>
    </LineStatusResponse>
  </StatusList>
</OrderStatusResponse>

© 2025, PartsSource Inc.