XML SHIPMENT ALERTS

This document deals with how customers can utilize the XML method of requesting shipment alerts. This methodology is also known as a “Web service” or an “API” (application programming interface).

Please strip out all non-standard or special characters from text fields. Including such characters in text fields will cause requests to fail.

To utilize the HTTP shipment alert API, you need to submit an HTTP request with a URL constructed as follows (replacing the example URL with your FACTS URL):

https://www.standardforwarding.com/scripts/cgiip.exe/WService=wsbroker1/xmlproalert.xml?pros=10003106,10003107&types=OFD,POD&email=email@email.com&xmluser=testuser&xmlpass=testpass

The program name is xmlproalert.xml. It takes five parameters:

• pros = a list of pronumbers
• types = a list of alert types. Allowed types are: SHIP, APPT, OFD, POD
• email = a list of email addresses
• xmluser = the user name
• xmlpass = the password

Sample Response: #

<?xml version="1.0" standalone="yes" ?>
<response>
  <responsetype>Proalert Entry</responsetype>
  <success>Yes</success>
  <proalerts>
    <proalert>
      <pronumber>3106</pronumber>
      <alerttype>OFD</alerttype>
      <emailto>email@email.com</emailto>
    </proalert>
    <proalert>
      <pronumber>3106</pronumber>
      <alerttype>POD</alerttype>
      <emailto>email@email.com</emailto>
    </proalert>
    <proalert>
      <pronumber>3107</pronumber>
      <alerttype>OFD</alerttype>
      <emailto>email@email.com</emailto>
    </proalert>
    <proalert>
      <pronumber>3107</pronumber>
      <alerttype>POD</alerttype>
      <emailto>email@email.com</emailto>
    </proalert>
  </proalerts>
</response>