PublicAPIService


Click here for a complete list of operations.

getSalesOrder

This function will return the details for the Sales Order specified.

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 /PublicAPIService.asmx HTTP/1.1
Host: langcompany.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getSalesOrder"

<?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>
    <getSalesOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SalesOrderNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </SalesOrderNumber>
    </getSalesOrder>
  </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>
    <getSalesOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSalesOrderResult>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <SONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </SONumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Message>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Message>
        <Status>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <ReqDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ReqDate>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <DiscountRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </DiscountRate>
        <Discount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Discount>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Tax>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Tax>
        <Total>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Total>
        <OnHoldCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <OrderType>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OrderType>
        <ChargeAccountID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ChargeAccountID>
        <ChargeMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ChargeMethod>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <Freight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Freight>
        <BilledFreight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </BilledFreight>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <ShipToStreet>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToStreet>
        <ShipToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCity>
        <ShipToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToState>
        <ShipToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToZip>
        <ShipToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCountry>
        <ShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipMethod>
        <ShipToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToName>
        <MailToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToATTN>
        <MailToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToName>
        <MailToStreet>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToStreet>
        <MailToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToCity>
        <MailToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToState>
        <MailToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToZip>
        <MailToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToCountry>
        <Warehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Warehouse>
        <Dropship>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Dropship>
        <Branch>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Branch>
        <Details>
          <SalesOrderDetail>
            <DetailID xsi:nil="true" />
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optOutCost xsi:nil="true" />
            <optCanceled xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
            <optCurrentWareHouse xsi:nil="true" />
            <optDefaultWareHouse xsi:nil="true" />
            <optDefaultBin xsi:nil="true" />
            <optBackOrdered xsi:nil="true" />
            <optPicketed xsi:nil="true" />
            <optShipped xsi:nil="true" />
            <optBilled xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ParentID xsi:nil="true" />
            <LineNumber xsi:nil="true" />
            <RollUpPrice xsi:nil="true" />
            <Hidden xsi:nil="true" />
            <SortOrder xsi:nil="true" />
            <Depth xsi:nil="true" />
            <Remarks xsi:nil="true" />
          </SalesOrderDetail>
          <SalesOrderDetail>
            <DetailID xsi:nil="true" />
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optOutCost xsi:nil="true" />
            <optCanceled xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
            <optCurrentWareHouse xsi:nil="true" />
            <optDefaultWareHouse xsi:nil="true" />
            <optDefaultBin xsi:nil="true" />
            <optBackOrdered xsi:nil="true" />
            <optPicketed xsi:nil="true" />
            <optShipped xsi:nil="true" />
            <optBilled xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ParentID xsi:nil="true" />
            <LineNumber xsi:nil="true" />
            <RollUpPrice xsi:nil="true" />
            <Hidden xsi:nil="true" />
            <SortOrder xsi:nil="true" />
            <Depth xsi:nil="true" />
            <Remarks xsi:nil="true" />
          </SalesOrderDetail>
        </Details>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </getSalesOrderResult>
    </getSalesOrderResponse>
  </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 /PublicAPIService.asmx HTTP/1.1
Host: langcompany.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:Body>
    <getSalesOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SalesOrderNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </SalesOrderNumber>
    </getSalesOrder>
  </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>
    <getSalesOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSalesOrderResult>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <SONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </SONumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <optBillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optBillToNumber>
        <optShipToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipToNumber>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Message>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Message>
        <Status>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <ReqDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </ReqDate>
        <CreateDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </CreateDate>
        <LastUpdate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </LastUpdate>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <DiscountRate>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </DiscountRate>
        <Discount>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Discount>
        <TaxCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </TaxCode>
        <Tax>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Tax>
        <Total>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Total>
        <OnHoldCode>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <OrderType>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OrderType>
        <ChargeAccountID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ChargeAccountID>
        <ChargeMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ChargeMethod>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <Freight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </Freight>
        <BilledFreight>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </BilledFreight>
        <ShipToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToATTN>
        <ShipToStreet>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToStreet>
        <ShipToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCity>
        <ShipToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToState>
        <ShipToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToZip>
        <ShipToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToCountry>
        <ShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipMethod>
        <ShipToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </ShipToName>
        <MailToATTN>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToATTN>
        <MailToName>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToName>
        <MailToStreet>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToStreet>
        <MailToCity>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToCity>
        <MailToState>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToState>
        <MailToZip>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToZip>
        <MailToCountry>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </MailToCountry>
        <Warehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Warehouse>
        <Dropship>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </Dropship>
        <Branch>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Branch>
        <Details>
          <SalesOrderDetail>
            <DetailID xsi:nil="true" />
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optOutCost xsi:nil="true" />
            <optCanceled xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
            <optCurrentWareHouse xsi:nil="true" />
            <optDefaultWareHouse xsi:nil="true" />
            <optDefaultBin xsi:nil="true" />
            <optBackOrdered xsi:nil="true" />
            <optPicketed xsi:nil="true" />
            <optShipped xsi:nil="true" />
            <optBilled xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ParentID xsi:nil="true" />
            <LineNumber xsi:nil="true" />
            <RollUpPrice xsi:nil="true" />
            <Hidden xsi:nil="true" />
            <SortOrder xsi:nil="true" />
            <Depth xsi:nil="true" />
            <Remarks xsi:nil="true" />
          </SalesOrderDetail>
          <SalesOrderDetail>
            <DetailID xsi:nil="true" />
            <Item xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Price xsi:nil="true" />
            <Description xsi:nil="true" />
            <ShipToTypeID xsi:nil="true" />
            <optOutCost xsi:nil="true" />
            <optCanceled xsi:nil="true" />
            <optEquipmentNumber xsi:nil="true" />
            <optContractNumber xsi:nil="true" />
            <optCurrentWareHouse xsi:nil="true" />
            <optDefaultWareHouse xsi:nil="true" />
            <optDefaultBin xsi:nil="true" />
            <optBackOrdered xsi:nil="true" />
            <optPicketed xsi:nil="true" />
            <optShipped xsi:nil="true" />
            <optBilled xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <ShipToContact xsi:nil="true" />
            <Notes xsi:nil="true" />
            <ParentID xsi:nil="true" />
            <LineNumber xsi:nil="true" />
            <RollUpPrice xsi:nil="true" />
            <Hidden xsi:nil="true" />
            <SortOrder xsi:nil="true" />
            <Depth xsi:nil="true" />
            <Remarks xsi:nil="true" />
          </SalesOrderDetail>
        </Details>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </getSalesOrderResult>
    </getSalesOrderResponse>
  </soap12:Body>
</soap12:Envelope>