GET api/Route/Shipment/{auth}/{ShipmentGUID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

string

Required
ShipmentGUID

string

Required

Body Parameters

None.

Response Information

Resource Description

ShipmentRouteResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.
ErrorMessage

string

None.
TransportLegs

Collection of ShipmentLegItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "TransportLegs": [
    {
      "ShipmentLhDetailID": 1,
      "ShipmentGUID": "sample string 2",
      "TransportLegID": 3,
      "SequenceNumber": 4,
      "CarrierID": 5,
      "CarrierName": "sample string 6",
      "CarrierIataID": "sample string 7",
      "CarrierKey": "sample string 8",
      "RouteNumber": "sample string 9",
      "DepartHubID": "sample string 10",
      "ScheduledDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ActualDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ArriveHubID": "sample string 11",
      "ScheduledArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ActualArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "Status": "sample string 12",
      "IsProblem": true,
      "ProblemDescription": "sample string 14",
      "InsertUserID": 15,
      "InsertDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "InactiveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "StatusDescription": "sample string 17",
      "CarrierIcon": "sample string 18",
      "ManifestGUID": "sample string 19",
      "ManifestNumber": 1,
      "WaybillNumber": "sample string 20",
      "DepartDateTimeDisplay": "sample string 21",
      "ArriveDateTimeDisplay": "sample string 22",
      "LegType": "sample string 23",
      "DepartCountryID": "sample string 24",
      "DepartCountryName": "sample string 25",
      "ArriveCountryID": "sample string 26",
      "ArriveCountryName": "sample string 27",
      "UpdatedDepartDateTimeUTC": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedArriveDateTimeUTC": "2024-09-19T09:10:59.1563359+00:00",
      "InsertUserName": "sample string 28",
      "LhInsertUserID": 1,
      "LhInsertDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "LhInsertUserName": "sample string 29",
      "CreatedBy": "sample string 30",
      "LhCreatedBy": "sample string 31",
      "EquipmentType": "sample string 32",
      "TransportMonitorGUID": "sample string 33",
      "ProviderMonitorID": "sample string 34",
      "TransportMonitorDisplay": "sample string 35",
      "AutoTrack": true
    },
    {
      "ShipmentLhDetailID": 1,
      "ShipmentGUID": "sample string 2",
      "TransportLegID": 3,
      "SequenceNumber": 4,
      "CarrierID": 5,
      "CarrierName": "sample string 6",
      "CarrierIataID": "sample string 7",
      "CarrierKey": "sample string 8",
      "RouteNumber": "sample string 9",
      "DepartHubID": "sample string 10",
      "ScheduledDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ActualDepartDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ArriveHubID": "sample string 11",
      "ScheduledArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "ActualArriveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "Status": "sample string 12",
      "IsProblem": true,
      "ProblemDescription": "sample string 14",
      "InsertUserID": 15,
      "InsertDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "InactiveDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "StatusDescription": "sample string 17",
      "CarrierIcon": "sample string 18",
      "ManifestGUID": "sample string 19",
      "ManifestNumber": 1,
      "WaybillNumber": "sample string 20",
      "DepartDateTimeDisplay": "sample string 21",
      "ArriveDateTimeDisplay": "sample string 22",
      "LegType": "sample string 23",
      "DepartCountryID": "sample string 24",
      "DepartCountryName": "sample string 25",
      "ArriveCountryID": "sample string 26",
      "ArriveCountryName": "sample string 27",
      "UpdatedDepartDateTimeUTC": "2024-09-19T09:10:59.1563359+00:00",
      "UpdatedArriveDateTimeUTC": "2024-09-19T09:10:59.1563359+00:00",
      "InsertUserName": "sample string 28",
      "LhInsertUserID": 1,
      "LhInsertDateTime": "2024-09-19T09:10:59.1563359+00:00",
      "LhInsertUserName": "sample string 29",
      "CreatedBy": "sample string 30",
      "LhCreatedBy": "sample string 31",
      "EquipmentType": "sample string 32",
      "TransportMonitorGUID": "sample string 33",
      "ProviderMonitorID": "sample string 34",
      "TransportMonitorDisplay": "sample string 35",
      "AutoTrack": true
    }
  ]
}

application/xml, text/xml

Sample: 
<ShipmentRouteResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <TransportLegs>
    <ShipmentLegItem>
      <ActualArriveDateTime>2024-09-19T09:10:59.1563359+00:00</ActualArriveDateTime>
      <ActualDepartDateTime>2024-09-19T09:10:59.1563359+00:00</ActualDepartDateTime>
      <ArriveCountryID>sample string 26</ArriveCountryID>
      <ArriveCountryName>sample string 27</ArriveCountryName>
      <ArriveDateTimeDisplay>sample string 22</ArriveDateTimeDisplay>
      <ArriveHubID>sample string 11</ArriveHubID>
      <AutoTrack>true</AutoTrack>
      <CarrierID>5</CarrierID>
      <CarrierIataID>sample string 7</CarrierIataID>
      <CarrierIcon>sample string 18</CarrierIcon>
      <CarrierKey>sample string 8</CarrierKey>
      <CarrierName>sample string 6</CarrierName>
      <CreatedBy>sample string 30</CreatedBy>
      <DepartCountryID>sample string 24</DepartCountryID>
      <DepartCountryName>sample string 25</DepartCountryName>
      <DepartDateTimeDisplay>sample string 21</DepartDateTimeDisplay>
      <DepartHubID>sample string 10</DepartHubID>
      <EquipmentType>sample string 32</EquipmentType>
      <InactiveDateTime>2024-09-19T09:10:59.1563359+00:00</InactiveDateTime>
      <InsertDateTime>2024-09-19T09:10:59.1563359+00:00</InsertDateTime>
      <InsertUserID>15</InsertUserID>
      <InsertUserName>sample string 28</InsertUserName>
      <IsProblem>true</IsProblem>
      <LegType>sample string 23</LegType>
      <LhCreatedBy>sample string 31</LhCreatedBy>
      <LhInsertDateTime>2024-09-19T09:10:59.1563359+00:00</LhInsertDateTime>
      <LhInsertUserID>1</LhInsertUserID>
      <LhInsertUserName>sample string 29</LhInsertUserName>
      <ManifestGUID>sample string 19</ManifestGUID>
      <ManifestNumber>1</ManifestNumber>
      <ProblemDescription>sample string 14</ProblemDescription>
      <ProviderMonitorID>sample string 34</ProviderMonitorID>
      <RouteNumber>sample string 9</RouteNumber>
      <ScheduledArriveDateTime>2024-09-19T09:10:59.1563359+00:00</ScheduledArriveDateTime>
      <ScheduledDepartDateTime>2024-09-19T09:10:59.1563359+00:00</ScheduledDepartDateTime>
      <SequenceNumber>4</SequenceNumber>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentLhDetailID>1</ShipmentLhDetailID>
      <Status>sample string 12</Status>
      <StatusDescription>sample string 17</StatusDescription>
      <TransportLegID>3</TransportLegID>
      <TransportMonitorDisplay>sample string 35</TransportMonitorDisplay>
      <TransportMonitorGUID>sample string 33</TransportMonitorGUID>
      <UpdatedArriveDateTime>2024-09-19T09:10:59.1563359+00:00</UpdatedArriveDateTime>
      <UpdatedArriveDateTimeUTC>2024-09-19T09:10:59.1563359+00:00</UpdatedArriveDateTimeUTC>
      <UpdatedDepartDateTime>2024-09-19T09:10:59.1563359+00:00</UpdatedDepartDateTime>
      <UpdatedDepartDateTimeUTC>2024-09-19T09:10:59.1563359+00:00</UpdatedDepartDateTimeUTC>
      <WaybillNumber>sample string 20</WaybillNumber>
    </ShipmentLegItem>
    <ShipmentLegItem>
      <ActualArriveDateTime>2024-09-19T09:10:59.1563359+00:00</ActualArriveDateTime>
      <ActualDepartDateTime>2024-09-19T09:10:59.1563359+00:00</ActualDepartDateTime>
      <ArriveCountryID>sample string 26</ArriveCountryID>
      <ArriveCountryName>sample string 27</ArriveCountryName>
      <ArriveDateTimeDisplay>sample string 22</ArriveDateTimeDisplay>
      <ArriveHubID>sample string 11</ArriveHubID>
      <AutoTrack>true</AutoTrack>
      <CarrierID>5</CarrierID>
      <CarrierIataID>sample string 7</CarrierIataID>
      <CarrierIcon>sample string 18</CarrierIcon>
      <CarrierKey>sample string 8</CarrierKey>
      <CarrierName>sample string 6</CarrierName>
      <CreatedBy>sample string 30</CreatedBy>
      <DepartCountryID>sample string 24</DepartCountryID>
      <DepartCountryName>sample string 25</DepartCountryName>
      <DepartDateTimeDisplay>sample string 21</DepartDateTimeDisplay>
      <DepartHubID>sample string 10</DepartHubID>
      <EquipmentType>sample string 32</EquipmentType>
      <InactiveDateTime>2024-09-19T09:10:59.1563359+00:00</InactiveDateTime>
      <InsertDateTime>2024-09-19T09:10:59.1563359+00:00</InsertDateTime>
      <InsertUserID>15</InsertUserID>
      <InsertUserName>sample string 28</InsertUserName>
      <IsProblem>true</IsProblem>
      <LegType>sample string 23</LegType>
      <LhCreatedBy>sample string 31</LhCreatedBy>
      <LhInsertDateTime>2024-09-19T09:10:59.1563359+00:00</LhInsertDateTime>
      <LhInsertUserID>1</LhInsertUserID>
      <LhInsertUserName>sample string 29</LhInsertUserName>
      <ManifestGUID>sample string 19</ManifestGUID>
      <ManifestNumber>1</ManifestNumber>
      <ProblemDescription>sample string 14</ProblemDescription>
      <ProviderMonitorID>sample string 34</ProviderMonitorID>
      <RouteNumber>sample string 9</RouteNumber>
      <ScheduledArriveDateTime>2024-09-19T09:10:59.1563359+00:00</ScheduledArriveDateTime>
      <ScheduledDepartDateTime>2024-09-19T09:10:59.1563359+00:00</ScheduledDepartDateTime>
      <SequenceNumber>4</SequenceNumber>
      <ShipmentGUID>sample string 2</ShipmentGUID>
      <ShipmentLhDetailID>1</ShipmentLhDetailID>
      <Status>sample string 12</Status>
      <StatusDescription>sample string 17</StatusDescription>
      <TransportLegID>3</TransportLegID>
      <TransportMonitorDisplay>sample string 35</TransportMonitorDisplay>
      <TransportMonitorGUID>sample string 33</TransportMonitorGUID>
      <UpdatedArriveDateTime>2024-09-19T09:10:59.1563359+00:00</UpdatedArriveDateTime>
      <UpdatedArriveDateTimeUTC>2024-09-19T09:10:59.1563359+00:00</UpdatedArriveDateTimeUTC>
      <UpdatedDepartDateTime>2024-09-19T09:10:59.1563359+00:00</UpdatedDepartDateTime>
      <UpdatedDepartDateTimeUTC>2024-09-19T09:10:59.1563359+00:00</UpdatedDepartDateTimeUTC>
      <WaybillNumber>sample string 20</WaybillNumber>
    </ShipmentLegItem>
  </TransportLegs>
</ShipmentRouteResp>