SxApiService Web Service

SxApiService

Click here for a complete list of operations.

OEGetSingleOrderV3

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 /SxApiService.asmx HTTP/1.1
Host: sxapi-mer.cameronashleybp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Nxtrend.WS/OEGetSingleOrderV3"

<?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>
    <OEGetSingleOrderV3 xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <orderNumber>int</orderNumber>
        <orderSuffix>int</orderSuffix>
        <lineSort>string</lineSort>
        <includeHeaderData>boolean</includeHeaderData>
        <includeTotalData>boolean</includeTotalData>
        <includeTaxData>boolean</includeTaxData>
        <includeLineData>boolean</includeLineData>
        <singleLineNumber>int</singleLineNumber>
      </requestObject>
    </OEGetSingleOrderV3>
  </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>
    <OEGetSingleOrderV3Response xmlns="Nxtrend.WS">
      <OEGetSingleOrderV3Result>
        <errorMessage>string</errorMessage>
        <arrayAvailableField>
          <OEGetSingleOrderV3.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleOrderV3.output.AvailableField>
          <OEGetSingleOrderV3.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleOrderV3.output.AvailableField>
        </arrayAvailableField>
        <arrayLineItem>
          <OEGetSingleOrderV3.output.LineItem>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <description1>string</description1>
            <description2>string</description2>
            <unitOfMeasure>string</unitOfMeasure>
            <quantityOrdered>double</quantityOrdered>
            <quantityShip>double</quantityShip>
            <price>double</price>
            <discountAmount>double</discountAmount>
            <discountType>string</discountType>
            <netOrdered>double</netOrdered>
            <netAmount>double</netAmount>
            <sortField>string</sortField>
            <rushFlag>boolean</rushFlag>
            <backorderType>string</backorderType>
            <promiseDate xsi:nil="true" />
            <requestedShipDate xsi:nil="true" />
            <tiedOrderType>string</tiedOrderType>
            <tiedOrderNumber>int</tiedOrderNumber>
            <tiedOrderString>string</tiedOrderString>
            <backorderNumber>int</backorderNumber>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <stockingQuantityShip>double</stockingQuantityShip>
          </OEGetSingleOrderV3.output.LineItem>
          <OEGetSingleOrderV3.output.LineItem>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <description1>string</description1>
            <description2>string</description2>
            <unitOfMeasure>string</unitOfMeasure>
            <quantityOrdered>double</quantityOrdered>
            <quantityShip>double</quantityShip>
            <price>double</price>
            <discountAmount>double</discountAmount>
            <discountType>string</discountType>
            <netOrdered>double</netOrdered>
            <netAmount>double</netAmount>
            <sortField>string</sortField>
            <rushFlag>boolean</rushFlag>
            <backorderType>string</backorderType>
            <promiseDate xsi:nil="true" />
            <requestedShipDate xsi:nil="true" />
            <tiedOrderType>string</tiedOrderType>
            <tiedOrderNumber>int</tiedOrderNumber>
            <tiedOrderString>string</tiedOrderString>
            <backorderNumber>int</backorderNumber>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <stockingQuantityShip>double</stockingQuantityShip>
          </OEGetSingleOrderV3.output.LineItem>
        </arrayLineItem>
        <arrayTaxMaster>
          <OEGetSingleOrderV3.output.TaxMaster>
            <sequenceNumber>int</sequenceNumber>
            <locality>string</locality>
            <taxEntity>string</taxEntity>
            <description>string</description>
            <group>string</group>
            <taxAmount>string</taxAmount>
            <taxSalesAmount>string</taxSalesAmount>
          </OEGetSingleOrderV3.output.TaxMaster>
          <OEGetSingleOrderV3.output.TaxMaster>
            <sequenceNumber>int</sequenceNumber>
            <locality>string</locality>
            <taxEntity>string</taxEntity>
            <description>string</description>
            <group>string</group>
            <taxAmount>string</taxAmount>
            <taxSalesAmount>string</taxSalesAmount>
          </OEGetSingleOrderV3.output.TaxMaster>
        </arrayTaxMaster>
        <arrayOrderTax>
          <OEGetSingleOrderV3.output.OrderTax>
            <recordType>int</recordType>
            <taxEntity>string</taxEntity>
            <taxBase>string</taxBase>
            <taxSalesAmount>string</taxSalesAmount>
            <salesRate>double</salesRate>
            <taxUseAmount>string</taxUseAmount>
            <useRate>double</useRate>
            <taxTransitAmount>string</taxTransitAmount>
            <transitRate>double</transitRate>
            <taxExciseAmount>string</taxExciseAmount>
            <exciseRate>double</exciseRate>
          </OEGetSingleOrderV3.output.OrderTax>
          <OEGetSingleOrderV3.output.OrderTax>
            <recordType>int</recordType>
            <taxEntity>string</taxEntity>
            <taxBase>string</taxBase>
            <taxSalesAmount>string</taxSalesAmount>
            <salesRate>double</salesRate>
            <taxUseAmount>string</taxUseAmount>
            <useRate>double</useRate>
            <taxTransitAmount>string</taxTransitAmount>
            <transitRate>double</transitRate>
            <taxExciseAmount>string</taxExciseAmount>
            <exciseRate>double</exciseRate>
          </OEGetSingleOrderV3.output.OrderTax>
        </arrayOrderTax>
      </OEGetSingleOrderV3Result>
    </OEGetSingleOrderV3Response>
  </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 /SxApiService.asmx HTTP/1.1
Host: sxapi-mer.cameronashleybp.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>
    <OEGetSingleOrderV3 xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <orderNumber>int</orderNumber>
        <orderSuffix>int</orderSuffix>
        <lineSort>string</lineSort>
        <includeHeaderData>boolean</includeHeaderData>
        <includeTotalData>boolean</includeTotalData>
        <includeTaxData>boolean</includeTaxData>
        <includeLineData>boolean</includeLineData>
        <singleLineNumber>int</singleLineNumber>
      </requestObject>
    </OEGetSingleOrderV3>
  </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>
    <OEGetSingleOrderV3Response xmlns="Nxtrend.WS">
      <OEGetSingleOrderV3Result>
        <errorMessage>string</errorMessage>
        <arrayAvailableField>
          <OEGetSingleOrderV3.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleOrderV3.output.AvailableField>
          <OEGetSingleOrderV3.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleOrderV3.output.AvailableField>
        </arrayAvailableField>
        <arrayLineItem>
          <OEGetSingleOrderV3.output.LineItem>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <description1>string</description1>
            <description2>string</description2>
            <unitOfMeasure>string</unitOfMeasure>
            <quantityOrdered>double</quantityOrdered>
            <quantityShip>double</quantityShip>
            <price>double</price>
            <discountAmount>double</discountAmount>
            <discountType>string</discountType>
            <netOrdered>double</netOrdered>
            <netAmount>double</netAmount>
            <sortField>string</sortField>
            <rushFlag>boolean</rushFlag>
            <backorderType>string</backorderType>
            <promiseDate xsi:nil="true" />
            <requestedShipDate xsi:nil="true" />
            <tiedOrderType>string</tiedOrderType>
            <tiedOrderNumber>int</tiedOrderNumber>
            <tiedOrderString>string</tiedOrderString>
            <backorderNumber>int</backorderNumber>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <stockingQuantityShip>double</stockingQuantityShip>
          </OEGetSingleOrderV3.output.LineItem>
          <OEGetSingleOrderV3.output.LineItem>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <description1>string</description1>
            <description2>string</description2>
            <unitOfMeasure>string</unitOfMeasure>
            <quantityOrdered>double</quantityOrdered>
            <quantityShip>double</quantityShip>
            <price>double</price>
            <discountAmount>double</discountAmount>
            <discountType>string</discountType>
            <netOrdered>double</netOrdered>
            <netAmount>double</netAmount>
            <sortField>string</sortField>
            <rushFlag>boolean</rushFlag>
            <backorderType>string</backorderType>
            <promiseDate xsi:nil="true" />
            <requestedShipDate xsi:nil="true" />
            <tiedOrderType>string</tiedOrderType>
            <tiedOrderNumber>int</tiedOrderNumber>
            <tiedOrderString>string</tiedOrderString>
            <backorderNumber>int</backorderNumber>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <stockingQuantityShip>double</stockingQuantityShip>
          </OEGetSingleOrderV3.output.LineItem>
        </arrayLineItem>
        <arrayTaxMaster>
          <OEGetSingleOrderV3.output.TaxMaster>
            <sequenceNumber>int</sequenceNumber>
            <locality>string</locality>
            <taxEntity>string</taxEntity>
            <description>string</description>
            <group>string</group>
            <taxAmount>string</taxAmount>
            <taxSalesAmount>string</taxSalesAmount>
          </OEGetSingleOrderV3.output.TaxMaster>
          <OEGetSingleOrderV3.output.TaxMaster>
            <sequenceNumber>int</sequenceNumber>
            <locality>string</locality>
            <taxEntity>string</taxEntity>
            <description>string</description>
            <group>string</group>
            <taxAmount>string</taxAmount>
            <taxSalesAmount>string</taxSalesAmount>
          </OEGetSingleOrderV3.output.TaxMaster>
        </arrayTaxMaster>
        <arrayOrderTax>
          <OEGetSingleOrderV3.output.OrderTax>
            <recordType>int</recordType>
            <taxEntity>string</taxEntity>
            <taxBase>string</taxBase>
            <taxSalesAmount>string</taxSalesAmount>
            <salesRate>double</salesRate>
            <taxUseAmount>string</taxUseAmount>
            <useRate>double</useRate>
            <taxTransitAmount>string</taxTransitAmount>
            <transitRate>double</transitRate>
            <taxExciseAmount>string</taxExciseAmount>
            <exciseRate>double</exciseRate>
          </OEGetSingleOrderV3.output.OrderTax>
          <OEGetSingleOrderV3.output.OrderTax>
            <recordType>int</recordType>
            <taxEntity>string</taxEntity>
            <taxBase>string</taxBase>
            <taxSalesAmount>string</taxSalesAmount>
            <salesRate>double</salesRate>
            <taxUseAmount>string</taxUseAmount>
            <useRate>double</useRate>
            <taxTransitAmount>string</taxTransitAmount>
            <transitRate>double</transitRate>
            <taxExciseAmount>string</taxExciseAmount>
            <exciseRate>double</exciseRate>
          </OEGetSingleOrderV3.output.OrderTax>
        </arrayOrderTax>
      </OEGetSingleOrderV3Result>
    </OEGetSingleOrderV3Response>
  </soap12:Body>
</soap12:Envelope>