shippers Web Service

shippers

Click here for a complete list of operations.

getNewSOShipPayments

get a blank SOShipPayments object

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ctapi/services/ctDynamicsSL/shippers.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinatechnology.com/services/ctDynamicsSL/getNewSOShipPayments"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap:Header>
  <soap:Body>
    <getNewSOShipPayments xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <CardAuthNbr>string</CardAuthNbr>
        <CardExpDate>dateTime</CardExpDate>
        <CardHldrName>string</CardHldrName>
        <CardNbr>string</CardNbr>
        <ChkNbr>string</ChkNbr>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPmtAmt>double</CuryPmtAmt>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NoteID>int</NoteID>
        <PmtAmt>double</PmtAmt>
        <PmtDate>dateTime</PmtDate>
        <PmtRef>string</PmtRef>
        <PmtTypeID>string</PmtTypeID>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <ShipperID>string</ShipperID>
        <Status>string</Status>
        <User1>string</User1>
        <User10>dateTime</User10>
        <User2>string</User2>
        <User3>string</User3>
        <User4>string</User4>
        <User5>double</User5>
        <User6>double</User6>
        <User7>string</User7>
        <User8>string</User8>
        <User9>dateTime</User9>
      </inTemplate>
    </getNewSOShipPayments>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getNewSOShipPaymentsResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewSOShipPaymentsResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <CardAuthNbr>string</CardAuthNbr>
        <CardExpDate>dateTime</CardExpDate>
        <CardHldrName>string</CardHldrName>
        <CardNbr>string</CardNbr>
        <ChkNbr>string</ChkNbr>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPmtAmt>double</CuryPmtAmt>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NoteID>int</NoteID>
        <PmtAmt>double</PmtAmt>
        <PmtDate>dateTime</PmtDate>
        <PmtRef>string</PmtRef>
        <PmtTypeID>string</PmtTypeID>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <ShipperID>string</ShipperID>
        <Status>string</Status>
        <User1>string</User1>
        <User10>dateTime</User10>
        <User2>string</User2>
        <User3>string</User3>
        <User4>string</User4>
        <User5>double</User5>
        <User6>double</User6>
        <User7>string</User7>
        <User8>string</User8>
        <User9>dateTime</User9>
      </getNewSOShipPaymentsResult>
    </getNewSOShipPaymentsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ctapi/services/ctDynamicsSL/shippers.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap12:Header>
  <soap12:Body>
    <getNewSOShipPayments xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <inTemplate>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <CardAuthNbr>string</CardAuthNbr>
        <CardExpDate>dateTime</CardExpDate>
        <CardHldrName>string</CardHldrName>
        <CardNbr>string</CardNbr>
        <ChkNbr>string</ChkNbr>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPmtAmt>double</CuryPmtAmt>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NoteID>int</NoteID>
        <PmtAmt>double</PmtAmt>
        <PmtDate>dateTime</PmtDate>
        <PmtRef>string</PmtRef>
        <PmtTypeID>string</PmtTypeID>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <ShipperID>string</ShipperID>
        <Status>string</Status>
        <User1>string</User1>
        <User10>dateTime</User10>
        <User2>string</User2>
        <User3>string</User3>
        <User4>string</User4>
        <User5>double</User5>
        <User6>double</User6>
        <User7>string</User7>
        <User8>string</User8>
        <User9>dateTime</User9>
      </inTemplate>
    </getNewSOShipPayments>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getNewSOShipPaymentsResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getNewSOShipPaymentsResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <CardAuthNbr>string</CardAuthNbr>
        <CardExpDate>dateTime</CardExpDate>
        <CardHldrName>string</CardHldrName>
        <CardNbr>string</CardNbr>
        <ChkNbr>string</ChkNbr>
        <CpnyID>string</CpnyID>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPmtAmt>double</CuryPmtAmt>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NoteID>int</NoteID>
        <PmtAmt>double</PmtAmt>
        <PmtDate>dateTime</PmtDate>
        <PmtRef>string</PmtRef>
        <PmtTypeID>string</PmtTypeID>
        <S4Future01>string</S4Future01>
        <S4Future02>string</S4Future02>
        <S4Future03>double</S4Future03>
        <S4Future04>double</S4Future04>
        <S4Future05>double</S4Future05>
        <S4Future06>double</S4Future06>
        <S4Future07>dateTime</S4Future07>
        <S4Future08>dateTime</S4Future08>
        <S4Future09>int</S4Future09>
        <S4Future10>int</S4Future10>
        <S4Future11>string</S4Future11>
        <S4Future12>string</S4Future12>
        <ShipperID>string</ShipperID>
        <Status>string</Status>
        <User1>string</User1>
        <User10>dateTime</User10>
        <User2>string</User2>
        <User3>string</User3>
        <User4>string</User4>
        <User5>double</User5>
        <User6>double</User6>
        <User7>string</User7>
        <User8>string</User8>
        <User9>dateTime</User9>
      </getNewSOShipPaymentsResult>
    </getNewSOShipPaymentsResponse>
  </soap12:Body>
</soap12:Envelope>