orders Web Service

orders

Click here for a complete list of operations.

getSOHeaderByOrdNbrByExactID

Gets SOHeader based on the passed ordNbr

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/orders.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/getSOHeaderByOrdNbrByExactID"

<?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>
    <getSOHeaderByOrdNbrByExactID xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <ordNbr>string</ordNbr>
    </getSOHeaderByOrdNbrByExactID>
  </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>
    <getSOHeaderByOrdNbrByExactIDResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <getSOHeaderByOrdNbrByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AddressType>string</AddressType>
        <AdminHold>short</AdminHold>
        <AppliedToDocRef>string</AppliedToDocRef>
        <ApprDetails>short</ApprDetails>
        <ApprRMA>short</ApprRMA>
        <ApprTech>short</ApprTech>
        <ARAcct>string</ARAcct>
        <ARSub>string</ARSub>
        <ASID>int</ASID>
        <ASID01>int</ASID01>
        <AuthNbr>string</AuthNbr>
        <AutoPO>short</AutoPO>
        <AutoPOVendID>string</AutoPOVendID>
        <AwardProbability>short</AwardProbability>
        <BalDue>double</BalDue>
        <BIInvoice>string</BIInvoice>
        <BillAddr1>string</BillAddr1>
        <BillAddr2>string</BillAddr2>
        <BillAddrSpecial>short</BillAddrSpecial>
        <BillAttn>string</BillAttn>
        <BillCity>string</BillCity>
        <BillCountry>string</BillCountry>
        <BillName>string</BillName>
        <BillPhone>string</BillPhone>
        <BillState>string</BillState>
        <BillThruProject>short</BillThruProject>
        <BillZip>string</BillZip>
        <BlktOrdNbr>string</BlktOrdNbr>
        <BookCntr>short</BookCntr>
        <BookCntrMisc>int</BookCntrMisc>
        <BuildAssyTime>short</BuildAssyTime>
        <BuildAvailDate>dateTime</BuildAvailDate>
        <BuildInvtID>string</BuildInvtID>
        <BuildQty>double</BuildQty>
        <BuildQtyUpdated>double</BuildQtyUpdated>
        <BuildSiteID>string</BuildSiteID>
        <BuyerID>string</BuyerID>
        <BuyerName>string</BuyerName>
        <CancelDate>dateTime</CancelDate>
        <Cancelled>short</Cancelled>
        <CancelShippers>short</CancelShippers>
        <CertID>string</CertID>
        <CertNoteID>int</CertNoteID>
        <ChainDisc>string</ChainDisc>
        <CmmnPct>double</CmmnPct>
        <ConsolInv>short</ConsolInv>
        <ContractNbr>string</ContractNbr>
        <CpnyID>string</CpnyID>
        <CreditApprDays>short</CreditApprDays>
        <CreditApprLimit>double</CreditApprLimit>
        <CreditChk>short</CreditChk>
        <CreditHold>short</CreditHold>
        <CreditHoldDate>dateTime</CreditHoldDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryBalDue>double</CuryBalDue>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPremFrtAmtAppld>double</CuryPremFrtAmtAppld>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <CuryTotFrt>double</CuryTotFrt>
        <CuryTotLineDisc>double</CuryTotLineDisc>
        <CuryTotMerch>double</CuryTotMerch>
        <CuryTotMisc>double</CuryTotMisc>
        <CuryTotOrd>double</CuryTotOrd>
        <CuryTotPmt>double</CuryTotPmt>
        <CuryTotPremFrt>double</CuryTotPremFrt>
        <CuryTotTax>double</CuryTotTax>
        <CuryTotTxbl>double</CuryTotTxbl>
        <CuryUnshippedBalance>double</CuryUnshippedBalance>
        <CuryWholeOrdDisc>double</CuryWholeOrdDisc>
        <CustGLClassID>string</CustGLClassID>
        <CustID>string</CustID>
        <CustOrdNbr>string</CustOrdNbr>
        <DateCancelled>dateTime</DateCancelled>
        <Dept>string</Dept>
        <DiscAcct>string</DiscAcct>
        <DiscPct>double</DiscPct>
        <DiscSub>string</DiscSub>
        <Div>string</Div>
        <DropShip>short</DropShip>
        <EDI810>short</EDI810>
        <EDI856>short</EDI856>
        <EDIPOID>string</EDIPOID>
        <EventCntr>short</EventCntr>
        <FOBID>string</FOBID>
        <FrtAcct>string</FrtAcct>
        <FrtCollect>short</FrtCollect>
        <FrtSub>string</FrtSub>
        <FrtTermsID>string</FrtTermsID>
        <GeoCode>string</GeoCode>
        <InvcDate>dateTime</InvcDate>
        <InvcNbr>string</InvcNbr>
        <IRDemand>short</IRDemand>
        <LanguageID>string</LanguageID>
        <LineCntr>short</LineCntr>
        <LostSaleID>string</LostSaleID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MarkFor>short</MarkFor>
        <MiscChrgCntr>short</MiscChrgCntr>
        <NextFunctionClass>string</NextFunctionClass>
        <NextFunctionID>string</NextFunctionID>
        <NoteId>int</NoteId>
        <OrdDate>dateTime</OrdDate>
        <OrdNbr>string</OrdNbr>
        <OrigOrdNbr>string</OrigOrdNbr>
        <PC_Status>string</PC_Status>
        <PerPost>string</PerPost>
        <PmtCntr>short</PmtCntr>
        <PremFrtAmtApplied>double</PremFrtAmtApplied>
        <Priority>short</Priority>
        <ProjectID>string</ProjectID>
        <QuoteDate>dateTime</QuoteDate>
        <Released>short</Released>
        <ReleaseValue>double</ReleaseValue>
        <RequireStepAssy>short</RequireStepAssy>
        <RequireStepInsp>short</RequireStepInsp>
        <RlseForInvc>short</RlseForInvc>
        <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>
        <SellingSiteID>string</SellingSiteID>
        <SFOOrdNbr>string</SFOOrdNbr>
        <ShipAddr1>string</ShipAddr1>
        <ShipAddr2>string</ShipAddr2>
        <ShipAddrID>string</ShipAddrID>
        <ShipAddrSpecial>short</ShipAddrSpecial>
        <ShipAttn>string</ShipAttn>
        <ShipCity>string</ShipCity>
        <ShipCmplt>short</ShipCmplt>
        <ShipCountry>string</ShipCountry>
        <ShipCustID>string</ShipCustID>
        <ShipGeoCode>string</ShipGeoCode>
        <ShipName>string</ShipName>
        <ShipPhone>string</ShipPhone>
        <ShipSiteID>string</ShipSiteID>
        <ShipState>string</ShipState>
        <ShiptoID>string</ShiptoID>
        <ShiptoType>string</ShiptoType>
        <ShipVendID>string</ShipVendID>
        <ShipViaID>string</ShipViaID>
        <ShipZip>string</ShipZip>
        <SlsperID>string</SlsperID>
        <SOTypeID>string</SOTypeID>
        <Status>string</Status>
        <TaxID00>string</TaxID00>
        <TaxID01>string</TaxID01>
        <TaxID02>string</TaxID02>
        <TaxID03>string</TaxID03>
        <TermsID>string</TermsID>
        <TotCommCost>double</TotCommCost>
        <TotCost>double</TotCost>
        <TotFrt>double</TotFrt>
        <TotLineDisc>double</TotLineDisc>
        <TotMerch>double</TotMerch>
        <TotMisc>double</TotMisc>
        <TotOrd>double</TotOrd>
        <TotPmt>double</TotPmt>
        <TotPremFrt>double</TotPremFrt>
        <TotShipWght>double</TotShipWght>
        <TotTax>double</TotTax>
        <TotTxbl>double</TotTxbl>
        <UnshippedBalance>double</UnshippedBalance>
        <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>
        <VendAddrID>string</VendAddrID>
        <WeekendDelivery>short</WeekendDelivery>
        <WholeOrdDisc>double</WholeOrdDisc>
        <WorkflowID>int</WorkflowID>
        <WorkflowStatus>string</WorkflowStatus>
        <WSID>int</WSID>
      </getSOHeaderByOrdNbrByExactIDResult>
    </getSOHeaderByOrdNbrByExactIDResponse>
  </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/orders.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>
    <getSOHeaderByOrdNbrByExactID xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <ordNbr>string</ordNbr>
    </getSOHeaderByOrdNbrByExactID>
  </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>
    <getSOHeaderByOrdNbrByExactIDResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <getSOHeaderByOrdNbrByExactIDResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AddressType>string</AddressType>
        <AdminHold>short</AdminHold>
        <AppliedToDocRef>string</AppliedToDocRef>
        <ApprDetails>short</ApprDetails>
        <ApprRMA>short</ApprRMA>
        <ApprTech>short</ApprTech>
        <ARAcct>string</ARAcct>
        <ARSub>string</ARSub>
        <ASID>int</ASID>
        <ASID01>int</ASID01>
        <AuthNbr>string</AuthNbr>
        <AutoPO>short</AutoPO>
        <AutoPOVendID>string</AutoPOVendID>
        <AwardProbability>short</AwardProbability>
        <BalDue>double</BalDue>
        <BIInvoice>string</BIInvoice>
        <BillAddr1>string</BillAddr1>
        <BillAddr2>string</BillAddr2>
        <BillAddrSpecial>short</BillAddrSpecial>
        <BillAttn>string</BillAttn>
        <BillCity>string</BillCity>
        <BillCountry>string</BillCountry>
        <BillName>string</BillName>
        <BillPhone>string</BillPhone>
        <BillState>string</BillState>
        <BillThruProject>short</BillThruProject>
        <BillZip>string</BillZip>
        <BlktOrdNbr>string</BlktOrdNbr>
        <BookCntr>short</BookCntr>
        <BookCntrMisc>int</BookCntrMisc>
        <BuildAssyTime>short</BuildAssyTime>
        <BuildAvailDate>dateTime</BuildAvailDate>
        <BuildInvtID>string</BuildInvtID>
        <BuildQty>double</BuildQty>
        <BuildQtyUpdated>double</BuildQtyUpdated>
        <BuildSiteID>string</BuildSiteID>
        <BuyerID>string</BuyerID>
        <BuyerName>string</BuyerName>
        <CancelDate>dateTime</CancelDate>
        <Cancelled>short</Cancelled>
        <CancelShippers>short</CancelShippers>
        <CertID>string</CertID>
        <CertNoteID>int</CertNoteID>
        <ChainDisc>string</ChainDisc>
        <CmmnPct>double</CmmnPct>
        <ConsolInv>short</ConsolInv>
        <ContractNbr>string</ContractNbr>
        <CpnyID>string</CpnyID>
        <CreditApprDays>short</CreditApprDays>
        <CreditApprLimit>double</CreditApprLimit>
        <CreditChk>short</CreditChk>
        <CreditHold>short</CreditHold>
        <CreditHoldDate>dateTime</CreditHoldDate>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CuryBalDue>double</CuryBalDue>
        <CuryEffDate>dateTime</CuryEffDate>
        <CuryID>string</CuryID>
        <CuryMultDiv>string</CuryMultDiv>
        <CuryPremFrtAmtAppld>double</CuryPremFrtAmtAppld>
        <CuryRate>double</CuryRate>
        <CuryRateType>string</CuryRateType>
        <CuryTotFrt>double</CuryTotFrt>
        <CuryTotLineDisc>double</CuryTotLineDisc>
        <CuryTotMerch>double</CuryTotMerch>
        <CuryTotMisc>double</CuryTotMisc>
        <CuryTotOrd>double</CuryTotOrd>
        <CuryTotPmt>double</CuryTotPmt>
        <CuryTotPremFrt>double</CuryTotPremFrt>
        <CuryTotTax>double</CuryTotTax>
        <CuryTotTxbl>double</CuryTotTxbl>
        <CuryUnshippedBalance>double</CuryUnshippedBalance>
        <CuryWholeOrdDisc>double</CuryWholeOrdDisc>
        <CustGLClassID>string</CustGLClassID>
        <CustID>string</CustID>
        <CustOrdNbr>string</CustOrdNbr>
        <DateCancelled>dateTime</DateCancelled>
        <Dept>string</Dept>
        <DiscAcct>string</DiscAcct>
        <DiscPct>double</DiscPct>
        <DiscSub>string</DiscSub>
        <Div>string</Div>
        <DropShip>short</DropShip>
        <EDI810>short</EDI810>
        <EDI856>short</EDI856>
        <EDIPOID>string</EDIPOID>
        <EventCntr>short</EventCntr>
        <FOBID>string</FOBID>
        <FrtAcct>string</FrtAcct>
        <FrtCollect>short</FrtCollect>
        <FrtSub>string</FrtSub>
        <FrtTermsID>string</FrtTermsID>
        <GeoCode>string</GeoCode>
        <InvcDate>dateTime</InvcDate>
        <InvcNbr>string</InvcNbr>
        <IRDemand>short</IRDemand>
        <LanguageID>string</LanguageID>
        <LineCntr>short</LineCntr>
        <LostSaleID>string</LostSaleID>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <MarkFor>short</MarkFor>
        <MiscChrgCntr>short</MiscChrgCntr>
        <NextFunctionClass>string</NextFunctionClass>
        <NextFunctionID>string</NextFunctionID>
        <NoteId>int</NoteId>
        <OrdDate>dateTime</OrdDate>
        <OrdNbr>string</OrdNbr>
        <OrigOrdNbr>string</OrigOrdNbr>
        <PC_Status>string</PC_Status>
        <PerPost>string</PerPost>
        <PmtCntr>short</PmtCntr>
        <PremFrtAmtApplied>double</PremFrtAmtApplied>
        <Priority>short</Priority>
        <ProjectID>string</ProjectID>
        <QuoteDate>dateTime</QuoteDate>
        <Released>short</Released>
        <ReleaseValue>double</ReleaseValue>
        <RequireStepAssy>short</RequireStepAssy>
        <RequireStepInsp>short</RequireStepInsp>
        <RlseForInvc>short</RlseForInvc>
        <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>
        <SellingSiteID>string</SellingSiteID>
        <SFOOrdNbr>string</SFOOrdNbr>
        <ShipAddr1>string</ShipAddr1>
        <ShipAddr2>string</ShipAddr2>
        <ShipAddrID>string</ShipAddrID>
        <ShipAddrSpecial>short</ShipAddrSpecial>
        <ShipAttn>string</ShipAttn>
        <ShipCity>string</ShipCity>
        <ShipCmplt>short</ShipCmplt>
        <ShipCountry>string</ShipCountry>
        <ShipCustID>string</ShipCustID>
        <ShipGeoCode>string</ShipGeoCode>
        <ShipName>string</ShipName>
        <ShipPhone>string</ShipPhone>
        <ShipSiteID>string</ShipSiteID>
        <ShipState>string</ShipState>
        <ShiptoID>string</ShiptoID>
        <ShiptoType>string</ShiptoType>
        <ShipVendID>string</ShipVendID>
        <ShipViaID>string</ShipViaID>
        <ShipZip>string</ShipZip>
        <SlsperID>string</SlsperID>
        <SOTypeID>string</SOTypeID>
        <Status>string</Status>
        <TaxID00>string</TaxID00>
        <TaxID01>string</TaxID01>
        <TaxID02>string</TaxID02>
        <TaxID03>string</TaxID03>
        <TermsID>string</TermsID>
        <TotCommCost>double</TotCommCost>
        <TotCost>double</TotCost>
        <TotFrt>double</TotFrt>
        <TotLineDisc>double</TotLineDisc>
        <TotMerch>double</TotMerch>
        <TotMisc>double</TotMisc>
        <TotOrd>double</TotOrd>
        <TotPmt>double</TotPmt>
        <TotPremFrt>double</TotPremFrt>
        <TotShipWght>double</TotShipWght>
        <TotTax>double</TotTax>
        <TotTxbl>double</TotTxbl>
        <UnshippedBalance>double</UnshippedBalance>
        <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>
        <VendAddrID>string</VendAddrID>
        <WeekendDelivery>short</WeekendDelivery>
        <WholeOrdDisc>double</WholeOrdDisc>
        <WorkflowID>int</WorkflowID>
        <WorkflowStatus>string</WorkflowStatus>
        <WSID>int</WSID>
      </getSOHeaderByOrdNbrByExactIDResult>
    </getSOHeaderByOrdNbrByExactIDResponse>
  </soap12:Body>
</soap12:Envelope>