Integration Service

Order Status Service

Part Query Service

Punchout

GetShipTracking API Reference

Documentation:

Returns a list of Ship Tracking Response objects that explains the ship status and available information for each reference id associated with the request parameter.

SOAP Method: GetShipTracking

REST Request: POST api/OrderStatus/ShipTracking

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: ListOfShipTrackingResponse
Parameters:
NameDescriptionTypeAdditional information
ReferenceId

integer

None.
TransitDays

integer

None.
TrackingStatus

string

None.
ShipmentReason

string

None.
TrackNumber

string

None.
TrackingType

string

None.
Carrier

string

None.
DateOrdered

date

None.
DateLastTracked

date

None.
DateShipped

date

None.
DateDelivered

date

None.
DateConfirmed

date

None.
ConfirmedById

integer

None.
ConfirmedByName

string

None.
SignedForName

string

None.
ExceptionCode

string

None.
ExceptionDetail

string

None.

Request Samples

application/json, text/json

Sample: 
{
  "lineReferenceId": 1,
  "orderReferenceId": 1,
  "purchaseReferenceId": 1,
  "facilityId": 1,
  "startDate": "2025-10-25T09:18:36.3252451-04:00",
  "endDate": "2025-10-25T09:18:36.3252451-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:18:36.3252451-04:00</EndDate>
  <FacilityId>1</FacilityId>
  <LineReferenceId>1</LineReferenceId>
  <OrderReferenceId>1</OrderReferenceId>
  <PurchaseReferenceId>1</PurchaseReferenceId>
  <StartDate>2025-10-25T09:18:36.3252451-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: 
[
  {
    "referenceId": 1,
    "transitDays": 1,
    "trackingStatus": "sample string 1",
    "shipmentReason": "sample string 2",
    "trackNumber": "sample string 3",
    "trackingType": "sample string 4",
    "carrier": "sample string 5",
    "dateOrdered": "2025-10-25T09:18:36.3252451-04:00",
    "dateLastTracked": "2025-10-25T09:18:36.3252451-04:00",
    "dateShipped": "2025-10-25T09:18:36.3252451-04:00",
    "dateDelivered": "2025-10-25T09:18:36.3252451-04:00",
    "dateConfirmed": "2025-10-25T09:18:36.3252451-04:00",
    "confirmedById": 1,
    "confirmedByName": "sample string 6",
    "signedForName": "sample string 7",
    "exceptionCode": "sample string 8",
    "exceptionDetail": "sample string 9"
  },
  {
    "referenceId": 1,
    "transitDays": 1,
    "trackingStatus": "sample string 1",
    "shipmentReason": "sample string 2",
    "trackNumber": "sample string 3",
    "trackingType": "sample string 4",
    "carrier": "sample string 5",
    "dateOrdered": "2025-10-25T09:18:36.3252451-04:00",
    "dateLastTracked": "2025-10-25T09:18:36.3252451-04:00",
    "dateShipped": "2025-10-25T09:18:36.3252451-04:00",
    "dateDelivered": "2025-10-25T09:18:36.3252451-04:00",
    "dateConfirmed": "2025-10-25T09:18:36.3252451-04:00",
    "confirmedById": 1,
    "confirmedByName": "sample string 6",
    "signedForName": "sample string 7",
    "exceptionCode": "sample string 8",
    "exceptionDetail": "sample string 9"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfShipTrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartsSource.Api.Model">
  <ShipTrackingResponse>
    <Carrier>sample string 5</Carrier>
    <ConfirmedById>1</ConfirmedById>
    <ConfirmedByName>sample string 6</ConfirmedByName>
    <DateConfirmed>2025-10-25T09:18:36.3252451-04:00</DateConfirmed>
    <DateDelivered>2025-10-25T09:18:36.3252451-04:00</DateDelivered>
    <DateLastTracked>2025-10-25T09:18:36.3252451-04:00</DateLastTracked>
    <DateOrdered>2025-10-25T09:18:36.3252451-04:00</DateOrdered>
    <DateShipped>2025-10-25T09:18:36.3252451-04:00</DateShipped>
    <ExceptionCode>sample string 8</ExceptionCode>
    <ExceptionDetail>sample string 9</ExceptionDetail>
    <ReferenceId>1</ReferenceId>
    <ShipmentReason>sample string 2</ShipmentReason>
    <SignedForName>sample string 7</SignedForName>
    <TrackNumber>sample string 3</TrackNumber>
    <TrackingStatus>sample string 1</TrackingStatus>
    <TrackingType>sample string 4</TrackingType>
    <TransitDays>1</TransitDays>
  </ShipTrackingResponse>
  <ShipTrackingResponse>
    <Carrier>sample string 5</Carrier>
    <ConfirmedById>1</ConfirmedById>
    <ConfirmedByName>sample string 6</ConfirmedByName>
    <DateConfirmed>2025-10-25T09:18:36.3252451-04:00</DateConfirmed>
    <DateDelivered>2025-10-25T09:18:36.3252451-04:00</DateDelivered>
    <DateLastTracked>2025-10-25T09:18:36.3252451-04:00</DateLastTracked>
    <DateOrdered>2025-10-25T09:18:36.3252451-04:00</DateOrdered>
    <DateShipped>2025-10-25T09:18:36.3252451-04:00</DateShipped>
    <ExceptionCode>sample string 8</ExceptionCode>
    <ExceptionDetail>sample string 9</ExceptionDetail>
    <ReferenceId>1</ReferenceId>
    <ShipmentReason>sample string 2</ShipmentReason>
    <SignedForName>sample string 7</SignedForName>
    <TrackNumber>sample string 3</TrackNumber>
    <TrackingStatus>sample string 1</TrackingStatus>
    <TrackingType>sample string 4</TrackingType>
    <TransitDays>1</TransitDays>
  </ShipTrackingResponse>
</ArrayOfShipTrackingResponse>

© 2025, PartsSource Inc.