Customer Facing Silver Express API (V1)

Retrieve the POD for a shipment

This will return the POD document if we have one available for the shipment. Populate HaulisticOrderNumber in the request. If we do not have a POD document for the shipment, PodExists will be false. If we do have a POD document, PodExists will be true. The filename and document data will also be returned.The document is returned in pdf format.

Sample request:

GET /Documents/GetProofOfDeliveryDocument HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "HaulisticOrderNumber": " ORD3370333"
}
        

Sample response:

{
  "podExists": true,
  "fileName": "ORD3370333-POD.pdf",
  "podFileData": []
}

Unit Types

Available unit types. i.e. Pallets, Boxes, etc.

Sample request:

GET /Entities/GetUnitTypes HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

Accessorial Services

Available accessorial services. i.e. Liftgate Pickup, Inside Pickup, etc.

Sample request:

GET /Entities/GetAccessorialServices HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

Hazmat Classes

Available hazmat classes. i.e. Corrosive Materials, Oxidizer, etc.

Sample request:

GET /Entities/GetHazmatClasses HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

Shipment Reference Numbers

Available shipment reference numbers. i.e. PO Number, Shipper Reference, etc.

Sample request:

GET /Entities/GetShipmentReferenceNumberTypes HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

Order Services

Available order services. i.e. SAME DAY, INTERMODAL, etc.

Sample request:

GET /Entities/GetOrderServiceTypes HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

EDI Status Codes

Valid EDI status codes that could be received by carriers for LTL shipments. i.e. AF = Carrier Departed Pick-up Location with Shipment

Sample request:

GET /Entities/GetEdiStatusCodes HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

EDI Reason Codes

Valid EDI reason codes that could be received by carriers for LTL shipments. i.e. NS = Normal Status

Sample request:

GET /Entities/GetEdiReasonCodes HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}

Query for LTL rates

It is recommended to provide as much detail as possible in the rate request, but most rates can be acquired for a zip to zip lane and class/ weight. If you intend to utilize the ShipQuote method to convert a quote into a live shipment, you will need to make sure the quote was originally created with full address and freight information.

Sample zip to zip request:

GET /Ltl/GetLtlRates HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {access_token}
Content-Length: {length of request body}
{
  "PickupWindow": {
    "Date": "2020-12-15"
  },
  "Shipper": {
    "CountryCode": "USA",
    "PostalCode": "53089"
  },
  "Consignee": {
    "CountryCode": "USA",
    "PostalCode": "60440"
  },
  "FreightItems": [
    {
      "Class": 55,
      "WeightInPounds": 1500
    }
  ]
}
        

Sample response:

{
  "quoteNumber": "ORD3366341QUO",
  "carrierRateOptions": [
    {
      "carrierScacCode": "FXFE",
      "carrierName": "FEDEX FREIGHT PRIORITY",
      "estimatedServiceDays": 1,
      "totalCharge": 186.2,
      "rateDetails": [
        {
          "description": "Base Rate",
          "charge": 524.3
        },
        {
          "description": "Discount",
          "charge": -368.57
        },
        {
          "description": "Discount",
          "charge": -2.1
        },
        {
          "description": "Fuel Surcharge",
          "charge": 32.57
        }
      ]
    }
  ]
}

Convert a quote to a shipment

If a quote was created with all required information to ship, you can create a shipment using the quote number and the carrier SCAC that you are selecting to ship with. First call /Ltl/GetLtlRates with all shipment information included in the request. Then call ShipQuote with that quote number and your selected carrier.

Sample /Ltl/GetLtlRates with all required shipment information included in the request:

GET /Ltl/GetLtlRates HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "PickupWindow": {
    "Date": "2020-12-15",
    "ReadyTime": "09:00:00",
    "CloseTime": "16:00:00"
  },
  "Shipper": {
    "Name": "SHIPPER",
    "Address1": "123 TEST PICKUP",
    "City": "SUSSEX",
    "StateCode": "WI",
    "CountryCode": "USA",
    "PostalCode": "53089",
    "AttentionToName": "JIM",
    "AttentionToPhone": "1234567890"
  },
  "Consignee": {
    "Name": "CONSIGNEE",
    "Address1": "123 TEST DELIVERY",
    "City": "BOLINGBROOK",
    "StateCode": "IL",
    "CountryCode": "USA",
    "PostalCode": "60440",
    "AttentionToName": "MIKE",
    "AttentionToPhone": "1234567890"
  },
  "FreightItems": [
    {
      "Description": "FREIGHT",
      "Class": 55,
      "Quantity": 1,
      "UnitTypeId": 1,
      "WeightInPounds": 1500,
      "LengthInches": 48,
      "WidthInches": 48,
      "HeightInches": 48
    }
  ]
}
        

Sample /Ltl/GetLtlRates response:

{
  "quoteNumber": "ORD3176918QUO",
  "carrierRateOptions": [
    {
      "carrierScacCode": "FXFE",
      "carrierName": "FEDEX FREIGHT PRIORITY",
      "estimatedServiceDays": 1,
      "totalCharge": 186.2,
      "rateDetails": [
        {
          "description": "Base Rate",
          "charge": 524.3
        },
        {
          "description": "Discount",
          "charge": -368.57
        },
        {
          "description": "Discount",
          "charge": -2.1
        },
        {
          "description": "Fuel Surcharge",
          "charge": 32.57
        }
      ]
    }
  ]
}

• The "quoteNumber" and "carrierScacCode" provided in the rate response above will be used to create the shipment
• Set "includeBillOfLadingDocument" to true if you would like a BOL pdf document returned
• Set "prescheduledPickup" to true if you already have a pickup scheduled with the carrier. Otherwise, ShipQuote will schedule the pickup with the carrier
• If you already have a pre-assigned Pro for the carrier, set that as "carrierProNumber".

Sample request:

POST /Ltl/ShipQuote HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "QuoteNumber": "ORD3176918QUO",
  "CarrierScacCode": "FXFE",
  "includeBillOfLadingDocument": false
}
        

Sample response:

{
  "shipmentNumber": "ORD3176919",
  "carrierPro": "62341392",
  "carrierPickupNumber": "2401254",
  "bolFileName": null,
  "bolFileData": null
}

Create a shipment

This allows creating a shipment immediately with or without a previous quote. All shipment information will need to be included in the request as well as the desired carrier. If a quote was obtained prior to creating the shipment, it is recommended to include the quote number in the request to ensure the quoted rate is applied. It is recommended to quote first and then include the quote number when creating the shipment. Note: If a quote number is included and the shipment information provided is different than the quote, you will receive a validation error.

• Set "includeBillOfLadingDocument" to true if you would like a BOL pdf document returned
• Set "prescheduledPickup" to true if you already have a pickup scheduled with the carrier. Otherwise, ShipQuote will schedule the pickup with the carrier
• If you already have a pre-assigned Pro for the carrier, set that as "carrierProNumber".
• If you have a quote for this shipment set that as "quoteNumber" to ensure you retain the quoted rate.

Sample request:

POST /Ltl/CreateShipment HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "PickupWindow": {
    "Date": "2020-12-20",
    "ReadyTime": "08:00:00",
    "CloseTime": "14:00:00"
  },
  "Shipper": {
    "Name": "TEST",
    "Address1": "123 Test AVE",
    "City": "SUSSEX",
    "StateCode": "WI",
    "CountryCode": "USA",
    "PostalCode": "53089",
    "AttentionToName": "BOB",
    "AttentionToPhone": "1234567890"
  },
  "Consignee": {
    "Name": "TEST dest",
    "Address1": "123 Test AVE",
    "Address2": null,
    "City": "BOLINGBROOK",
    "StateCode": "IL",
    "CountryCode": "USA",
    "PostalCode": "60440",
    "AttentionToName": "DAVE",
    "AttentionToPhone": "1234567890"
  },
  "CarrierScacCode": "RDFS",
  "PickupSpecialInstructions": "Pickup prior to 2pm",
  "DeliverySpecialInstructions": "Dock door 4",
  "FreightItems": [
    {
      "Description": "FREIGHT",
      "Class": 55,
      "Quantity": 1,
      "UnitTypeId": 1,
      "WeightInPounds": 1500,
      "LengthInches": 48,
      "WidthInches": 48,
      "HeightInches": 48,
      "DeclaredValue": 15000,
      "IsHazmat": false
    }
  ],
  "includeBillOfLadingDocument": false,
  "quoteNumber": "ORD12345QUO"
}
        

Sample response:

{
  "shipmentNumber": "ORD3176920",
  "carrierPro": "85236552",
  "carrierPickupNumber": "12444",
  "bolFileName": null,
  "bolFileData": null
}

Retrieve the status of a shipment

This will return the status of an LTL shipment by the Haulistic order number that was returned from either Ltl/CreateShipment or Ltl/ShipQuote. The overall shipment status will be returned in the response (Planning, Enroute, Delivered). It will also include a list of shipment activity which will show information provided back from the carrier and can include events such as pickup, arrival/departure at carrier terminals and delivery. The status and reason codes can be any valid EDI code from 214 EDI status updates. Valid status and reason codes can be retrieved from Entities

Sample request:

GET /Ltl/GetShipmentStatus HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "HaulisticOrderNumber": " ORD3370333"
}
        

Sample response:

{
  "haulisticOrderNumber": "ORD3370333",
  "haulisticProNumber": "QE1970844",
  "status": "Delivered",
  "activity": [
    {
      "carrierScac": "FXNL",
      "carrierPro": "368818142",
      "activityDate": "2020-12-11T01:25:00",
      "city": "Newburgh",
      "state": "NY",
      "country": "US",
      "activityComment": null,
      "statusCode": "AF",
      "statusDescription": "Carrier Departed Pick-up Location with Shipment",
      "reasonCode": null,
      "reasonDescription": null
    },
    {
      "carrierScac": "FXNL",
      "carrierPro": "368818142",
      "activityDate": "2020-12-11T09:14:00",
      "city": "LONG ISLAND CITY",
      "state": "NY",
      "country": "US",
      "activityComment": null,
      "statusCode": "D1",
      "statusDescription": "Completed Unloading at Delivery Location",
      "reasonCode": "NS",
      "reasonDescription": "Normal Status"
    }
  ]
}

Create a shipment

This allows creating a shipment immediately. All shipment information will need to be included in the request.

Sample request:

POST /Shipment/CreateShipment HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "OrderServiceId": 3,
  "Shipper": {
    "Name": "TEST",
    "Address1": "123 Test AVE",
    "Address2": null,
    "City": "WAUKESHA",
    "StateCode": "WI",
    "CountryCode": "USA",
    "PostalCode": "53188",
    "AttentionToName": "Jim",
    "AttentionToPhone": "1234567890"
  },
  "PickupWindow": {
    "Date": "2025-12-01",
    "ReadyTime": "06:00:00",
    "CloseTime": "17:00:00"
  },
  "PickupSpecialInstructions": "PickupSpecialInstructions",
  "Consignee": {
    "Name": "TEST dest",
    "Address1": "123 Test AVE",
    "Address2": null,
    "City": "SUSSEX",
    "StateCode": "WI",
    "CountryCode": "USA",
    "PostalCode": "53089",
    "AttentionToName": "Mike",
    "AttentionToPhone": "1234567890"
  },
  "DeliveryWindow": {
    "Date": "2025-12-10",
    "ReadyTime": "06:00:00",
    "CloseTime": "17:00:00"
  },
  "DeliverySpecialInstructions": "DeliverySpecialInstructions",
  "FreightItems": [
    {
      "Description": "FREIGHT",
      "WeightInPounds": 1500,
      "Class": 55,
      "Quantity": 1,
      "UnitTypeId": 1,
      "LengthInches": 48,
      "WidthInches": 48,
      "HeightInches": 48
    }
  ],
  "ShipmentReferenceNumbers": [
    {
      "ShipmentReferenceNumberTypeId": 1,
      "ShipmentReferenceNumberValue": "Value"
    }
  ]
}
        

Sample response:

{
  "success": true,
  "orderNumber": "ORD8540443",
  "LabelDocument": "JVBERi0xLjU=",
  "errors": null
}

Retrieve the status of a shipment

This will return the status of a shipment by the original QE order number that was returned from Shipment/CreateShipment. The overall shipment status will be returned in the response (Planning, Enroute, Delivered). If proof of delivery was obtained, PodDate will be populated.

Sample request:

GET /Shipment/GetShipmentStatus HTTP/1.1
Host: staging-api-silverexpress.shiphaulistic.com
Content-Type: application/json
Authorization: Bearer {Your access_token}
Content-Length: {length of request body}
{
  "HaulisticOrderNumber": " ORD3370333"
}
        

Sample response:

{
   "status": "Delivered",
   "podDate": "2025-02-07T08:00:00",
   "podSignature": "Bob",
   "locationUpdates": [
       {
           "date": "2025-02-04T15:00:00",
           "locationName": "NAME",
           "address": "123 MAIN ST",
           "city": "WARRENVILLE",
           "state": "IL",
           "zip": "60555",
           "countryCode": "US",
           "portCode": null
       },
       {
           "date": "2025-02-04T17:00:00",
           "locationName": "CHICAGO",
           "address": null,
           "city": "CHICAGO",
           "state": "IL",
           "zip": "60018",
           "countryCode": "US",
           "portCode": "ORD"
       }
   ]

}