GET api/GetShipmentStatus?User={User}&Pass={Pass}&SearchFor={SearchFor}&SearchType={SearchType}

Use this API function to retrieve the recorded shipment status(es) for the targeted Shipment

Request Information

URI Parameters

Name	Description	Type	Additional information
User	Enter the Logon Code assigned to your account (1-8 characters)	string	Required
Pass	Enter the Password associated with your Logon Code	string	Required
SearchFor	Enter the value associated with the SearchType parameter with which to locate the desired shipment	string	Required
SearchType	Enter the appropriate value that defines the context of the SearchFor parameter: 1=PRO Number Search, 2=BOL Number Search, 3=PO Number Search, 4=SID Number Search, 5=Carrier Pro Number Search	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns basic shipment information along with any accumulated shipment statuses, much like an EDI 214 document.

StatusResults

Name	Description	Type	Additional information
ErrorMessage	Contains a brief description as to why the Status Request was NOT Successful, whereas a Blank value indicates Success.	string	None.
ShipFrom	Name and address information pertaining to the SHIP FROM location	ShippingPoint	None.
ShipTo	Name and address information pertaining to the SHIP TO location	ShippingPoint	None.
GeneralInfo	Represents information that [uniquely] identifies the shipment	ProInfo	None.
Freight	Description of Freight associated with the shipment for which ShipmentStatus was requested	Collection of FreightDetail	None.
StatusList	Details the list of statuses for this shipment	Collection of Status	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 1",
  "ShipFrom": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "Address3": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7"
  },
  "ShipTo": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "Address3": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7"
  },
  "GeneralInfo": {
    "ProNumber": "sample string 1",
    "ShipmentDate": "sample string 2",
    "BOLnumber": "sample string 3",
    "POnumber": "sample string 4",
    "SIDnumber": "sample string 5",
    "PmtType": "sample string 6",
    "TotalWeight": "sample string 7",
    "TotalPCS": "sample string 8",
    "TotalPallets": "sample string 9",
    "TotalCube": "sample string 10",
    "WhoSigned": "sample string 11",
    "BillingReferences": [
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      },
      {
        "Code": "sample string 1",
        "Description": "sample string 2",
        "Value": "sample string 3"
      }
    ]
  },
  "Freight": [
    {
      "FreightDescription": "sample string 1",
      "FreightClass": "sample string 2",
      "Weight": 3,
      "PalletCount": 4,
      "PieceCount": 5,
      "Length": 6,
      "Height": 7,
      "Width": 8,
      "HazmatUNnumber": "sample string 9",
      "HazmatClass": "sample string 10",
      "HazmatPackingGroup": "sample string 11",
      "HazmatProperName": "sample string 12"
    },
    {
      "FreightDescription": "sample string 1",
      "FreightClass": "sample string 2",
      "Weight": 3,
      "PalletCount": 4,
      "PieceCount": 5,
      "Length": 6,
      "Height": 7,
      "Width": 8,
      "HazmatUNnumber": "sample string 9",
      "HazmatClass": "sample string 10",
      "HazmatPackingGroup": "sample string 11",
      "HazmatProperName": "sample string 12"
    }
  ],
  "StatusList": [
    {
      "StatusCode": "sample string 1",
      "StatusDefinition": "sample string 2",
      "ReasonCode": "sample string 3",
      "ReasonDefinition": "sample string 4",
      "StatusDate": "sample string 5",
      "StatusTime": "sample string 6",
      "TimeCode": "sample string 7",
      "TripNumber": "sample string 8",
      "TruckNumber": "sample string 9"
    },
    {
      "StatusCode": "sample string 1",
      "StatusDefinition": "sample string 2",
      "ReasonCode": "sample string 3",
      "ReasonDefinition": "sample string 4",
      "StatusDate": "sample string 5",
      "StatusTime": "sample string 6",
      "TimeCode": "sample string 7",
      "TripNumber": "sample string 8",
      "TruckNumber": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<StatusResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Freight>
    <FreightDetail>
      <FreightClass>sample string 2</FreightClass>
      <FreightDescription>sample string 1</FreightDescription>
      <HazmatClass>sample string 10</HazmatClass>
      <HazmatPackingGroup>sample string 11</HazmatPackingGroup>
      <HazmatProperName>sample string 12</HazmatProperName>
      <HazmatUNnumber>sample string 9</HazmatUNnumber>
      <Height>7</Height>
      <Length>6</Length>
      <PalletCount>4</PalletCount>
      <PieceCount>5</PieceCount>
      <Weight>3</Weight>
      <Width>8</Width>
    </FreightDetail>
    <FreightDetail>
      <FreightClass>sample string 2</FreightClass>
      <FreightDescription>sample string 1</FreightDescription>
      <HazmatClass>sample string 10</HazmatClass>
      <HazmatPackingGroup>sample string 11</HazmatPackingGroup>
      <HazmatProperName>sample string 12</HazmatProperName>
      <HazmatUNnumber>sample string 9</HazmatUNnumber>
      <Height>7</Height>
      <Length>6</Length>
      <PalletCount>4</PalletCount>
      <PieceCount>5</PieceCount>
      <Weight>3</Weight>
      <Width>8</Width>
    </FreightDetail>
  </Freight>
  <GeneralInfo>
    <BOLnumber>sample string 3</BOLnumber>
    <BillingReferences>
      <BillingReference>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Value>sample string 3</Value>
      </BillingReference>
      <BillingReference>
        <Code>sample string 1</Code>
        <Description>sample string 2</Description>
        <Value>sample string 3</Value>
      </BillingReference>
    </BillingReferences>
    <POnumber>sample string 4</POnumber>
    <PmtType>sample string 6</PmtType>
    <ProNumber>sample string 1</ProNumber>
    <SIDnumber>sample string 5</SIDnumber>
    <ShipmentDate>sample string 2</ShipmentDate>
    <TotalCube>sample string 10</TotalCube>
    <TotalPCS>sample string 8</TotalPCS>
    <TotalPallets>sample string 9</TotalPallets>
    <TotalWeight>sample string 7</TotalWeight>
    <WhoSigned>sample string 11</WhoSigned>
  </GeneralInfo>
  <ShipFrom>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <City>sample string 5</City>
    <Name>sample string 1</Name>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
  </ShipFrom>
  <ShipTo>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <City>sample string 5</City>
    <Name>sample string 1</Name>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
  </ShipTo>
  <StatusList>
    <Status>
      <ReasonCode>sample string 3</ReasonCode>
      <ReasonDefinition>sample string 4</ReasonDefinition>
      <StatusCode>sample string 1</StatusCode>
      <StatusDate>sample string 5</StatusDate>
      <StatusDefinition>sample string 2</StatusDefinition>
      <StatusTime>sample string 6</StatusTime>
      <TimeCode>sample string 7</TimeCode>
      <TripNumber>sample string 8</TripNumber>
      <TruckNumber>sample string 9</TruckNumber>
    </Status>
    <Status>
      <ReasonCode>sample string 3</ReasonCode>
      <ReasonDefinition>sample string 4</ReasonDefinition>
      <StatusCode>sample string 1</StatusCode>
      <StatusDate>sample string 5</StatusDate>
      <StatusDefinition>sample string 2</StatusDefinition>
      <StatusTime>sample string 6</StatusTime>
      <TimeCode>sample string 7</TimeCode>
      <TripNumber>sample string 8</TripNumber>
      <TruckNumber>sample string 9</TruckNumber>
    </Status>
  </StatusList>
</StatusResults>