shippers Web Service

shippers

Click here for a complete list of operations.

getSOAddressesByShipToID

Searches for ShipToIds by custID and ShipToId

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/getSOAddressesByShipToID"

<?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>
    <getSOAddressesByShipToID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <custID>string</custID>
      <shipToID>string</shipToID>
    </getSOAddressesByShipToID>
  </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>
    <getSOAddressesByShipToIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getSOAddressesByShipToIDResult>
        <SOAddress>
          <counter>int</counter>
          <totalEntries>int</totalEntries>
          <totalPages>int</totalPages>
          <errorMessage>string</errorMessage>
          <Notes>string</Notes>
          <resultCode>int</resultCode>
          <Addr1>string</Addr1>
          <Addr2>string</Addr2>
          <Attn>string</Attn>
          <City>string</City>
          <COGSAcct>string</COGSAcct>
          <COGSSub>string</COGSSub>
          <Country>string</Country>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CustId>string</CustId>
          <Descr>string</Descr>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <EMailAddr>string</EMailAddr>
          <Fax>string</Fax>
          <FOB>string</FOB>
          <FrghtCode>string</FrghtCode>
          <FrtAcct>string</FrtAcct>
          <FrtSub>string</FrtSub>
          <FrtTermsID>string</FrtTermsID>
          <GeoCode>string</GeoCode>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MapLocation>string</MapLocation>
          <MiscAcct>string</MiscAcct>
          <MiscSub>string</MiscSub>
          <Name>string</Name>
          <NoteId>int</NoteId>
          <Phone>string</Phone>
          <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>
          <ShipToId>string</ShipToId>
          <ShipViaID>string</ShipViaID>
          <SiteID>string</SiteID>
          <SlsAcct>string</SlsAcct>
          <SlsPerID>string</SlsPerID>
          <SlsSub>string</SlsSub>
          <State>string</State>
          <Status>string</Status>
          <TaxId00>string</TaxId00>
          <TaxId01>string</TaxId01>
          <TaxId02>string</TaxId02>
          <TaxId03>string</TaxId03>
          <TaxLocId>string</TaxLocId>
          <TaxRegNbr>string</TaxRegNbr>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <Zip>string</Zip>
        </SOAddress>
        <SOAddress>
          <counter>int</counter>
          <totalEntries>int</totalEntries>
          <totalPages>int</totalPages>
          <errorMessage>string</errorMessage>
          <Notes>string</Notes>
          <resultCode>int</resultCode>
          <Addr1>string</Addr1>
          <Addr2>string</Addr2>
          <Attn>string</Attn>
          <City>string</City>
          <COGSAcct>string</COGSAcct>
          <COGSSub>string</COGSSub>
          <Country>string</Country>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CustId>string</CustId>
          <Descr>string</Descr>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <EMailAddr>string</EMailAddr>
          <Fax>string</Fax>
          <FOB>string</FOB>
          <FrghtCode>string</FrghtCode>
          <FrtAcct>string</FrtAcct>
          <FrtSub>string</FrtSub>
          <FrtTermsID>string</FrtTermsID>
          <GeoCode>string</GeoCode>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MapLocation>string</MapLocation>
          <MiscAcct>string</MiscAcct>
          <MiscSub>string</MiscSub>
          <Name>string</Name>
          <NoteId>int</NoteId>
          <Phone>string</Phone>
          <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>
          <ShipToId>string</ShipToId>
          <ShipViaID>string</ShipViaID>
          <SiteID>string</SiteID>
          <SlsAcct>string</SlsAcct>
          <SlsPerID>string</SlsPerID>
          <SlsSub>string</SlsSub>
          <State>string</State>
          <Status>string</Status>
          <TaxId00>string</TaxId00>
          <TaxId01>string</TaxId01>
          <TaxId02>string</TaxId02>
          <TaxId03>string</TaxId03>
          <TaxLocId>string</TaxLocId>
          <TaxRegNbr>string</TaxRegNbr>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <Zip>string</Zip>
        </SOAddress>
      </getSOAddressesByShipToIDResult>
    </getSOAddressesByShipToIDResponse>
  </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>
    <getSOAddressesByShipToID xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <custID>string</custID>
      <shipToID>string</shipToID>
    </getSOAddressesByShipToID>
  </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>
    <getSOAddressesByShipToIDResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getSOAddressesByShipToIDResult>
        <SOAddress>
          <counter>int</counter>
          <totalEntries>int</totalEntries>
          <totalPages>int</totalPages>
          <errorMessage>string</errorMessage>
          <Notes>string</Notes>
          <resultCode>int</resultCode>
          <Addr1>string</Addr1>
          <Addr2>string</Addr2>
          <Attn>string</Attn>
          <City>string</City>
          <COGSAcct>string</COGSAcct>
          <COGSSub>string</COGSSub>
          <Country>string</Country>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CustId>string</CustId>
          <Descr>string</Descr>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <EMailAddr>string</EMailAddr>
          <Fax>string</Fax>
          <FOB>string</FOB>
          <FrghtCode>string</FrghtCode>
          <FrtAcct>string</FrtAcct>
          <FrtSub>string</FrtSub>
          <FrtTermsID>string</FrtTermsID>
          <GeoCode>string</GeoCode>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MapLocation>string</MapLocation>
          <MiscAcct>string</MiscAcct>
          <MiscSub>string</MiscSub>
          <Name>string</Name>
          <NoteId>int</NoteId>
          <Phone>string</Phone>
          <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>
          <ShipToId>string</ShipToId>
          <ShipViaID>string</ShipViaID>
          <SiteID>string</SiteID>
          <SlsAcct>string</SlsAcct>
          <SlsPerID>string</SlsPerID>
          <SlsSub>string</SlsSub>
          <State>string</State>
          <Status>string</Status>
          <TaxId00>string</TaxId00>
          <TaxId01>string</TaxId01>
          <TaxId02>string</TaxId02>
          <TaxId03>string</TaxId03>
          <TaxLocId>string</TaxLocId>
          <TaxRegNbr>string</TaxRegNbr>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <Zip>string</Zip>
        </SOAddress>
        <SOAddress>
          <counter>int</counter>
          <totalEntries>int</totalEntries>
          <totalPages>int</totalPages>
          <errorMessage>string</errorMessage>
          <Notes>string</Notes>
          <resultCode>int</resultCode>
          <Addr1>string</Addr1>
          <Addr2>string</Addr2>
          <Attn>string</Attn>
          <City>string</City>
          <COGSAcct>string</COGSAcct>
          <COGSSub>string</COGSSub>
          <Country>string</Country>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CustId>string</CustId>
          <Descr>string</Descr>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <EMailAddr>string</EMailAddr>
          <Fax>string</Fax>
          <FOB>string</FOB>
          <FrghtCode>string</FrghtCode>
          <FrtAcct>string</FrtAcct>
          <FrtSub>string</FrtSub>
          <FrtTermsID>string</FrtTermsID>
          <GeoCode>string</GeoCode>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MapLocation>string</MapLocation>
          <MiscAcct>string</MiscAcct>
          <MiscSub>string</MiscSub>
          <Name>string</Name>
          <NoteId>int</NoteId>
          <Phone>string</Phone>
          <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>
          <ShipToId>string</ShipToId>
          <ShipViaID>string</ShipViaID>
          <SiteID>string</SiteID>
          <SlsAcct>string</SlsAcct>
          <SlsPerID>string</SlsPerID>
          <SlsSub>string</SlsSub>
          <State>string</State>
          <Status>string</Status>
          <TaxId00>string</TaxId00>
          <TaxId01>string</TaxId01>
          <TaxId02>string</TaxId02>
          <TaxId03>string</TaxId03>
          <TaxLocId>string</TaxLocId>
          <TaxRegNbr>string</TaxRegNbr>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <Zip>string</Zip>
        </SOAddress>
      </getSOAddressesByShipToIDResult>
    </getSOAddressesByShipToIDResponse>
  </soap12:Body>
</soap12:Envelope>