SxApiService Web Service

SxApiService

Click here for a complete list of operations.

OEGetSingleBatchOrder

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

<?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>
    <OEGetSingleBatchOrder xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <batchName>string</batchName>
        <sequenceNumber>int</sequenceNumber>
        <lineSort>string</lineSort>
        <includeHeaderData>boolean</includeHeaderData>
        <includeTotalData>boolean</includeTotalData>
        <includeTaxData>boolean</includeTaxData>
        <includeLineData>boolean</includeLineData>
      </requestObject>
    </OEGetSingleBatchOrder>
  </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>
    <OEGetSingleBatchOrderResponse xmlns="Nxtrend.WS">
      <OEGetSingleBatchOrderResult>
        <errorMessage>string</errorMessage>
        <arrayAvailableField>
          <OEGetSingleBatchOrder.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleBatchOrder.output.AvailableField>
          <OEGetSingleBatchOrder.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleBatchOrder.output.AvailableField>
        </arrayAvailableField>
        <arrayLineItem>
          <OEGetSingleBatchOrder.output.LineItem>
            <batchName>string</batchName>
            <sequenceNumber>int</sequenceNumber>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <productDescription>string</productDescription>
            <productNotesFlag>string</productNotesFlag>
            <commentFlag>string</commentFlag>
            <quantityOrdered>double</quantityOrdered>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <unit>string</unit>
            <progressRecId>int</progressRecId>
            <costPerStockingUnit>double</costPerStockingUnit>
            <specialConversion>int</specialConversion>
            <priceCostPer>string</priceCostPer>
            <specialCostType>string</specialCostType>
            <icSpecRecNo>int</icSpecRecNo>
            <price>double</price>
            <productCost>double</productCost>
            <discountAmount>double</discountAmount>
            <netAmount>double</netAmount>
            <displayPrice>string</displayPrice>
            <displayDiscountAmount>string</displayDiscountAmount>
            <displayNetAmount>string</displayNetAmount>
            <sortField>string</sortField>
          </OEGetSingleBatchOrder.output.LineItem>
          <OEGetSingleBatchOrder.output.LineItem>
            <batchName>string</batchName>
            <sequenceNumber>int</sequenceNumber>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <productDescription>string</productDescription>
            <productNotesFlag>string</productNotesFlag>
            <commentFlag>string</commentFlag>
            <quantityOrdered>double</quantityOrdered>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <unit>string</unit>
            <progressRecId>int</progressRecId>
            <costPerStockingUnit>double</costPerStockingUnit>
            <specialConversion>int</specialConversion>
            <priceCostPer>string</priceCostPer>
            <specialCostType>string</specialCostType>
            <icSpecRecNo>int</icSpecRecNo>
            <price>double</price>
            <productCost>double</productCost>
            <discountAmount>double</discountAmount>
            <netAmount>double</netAmount>
            <displayPrice>string</displayPrice>
            <displayDiscountAmount>string</displayDiscountAmount>
            <displayNetAmount>string</displayNetAmount>
            <sortField>string</sortField>
          </OEGetSingleBatchOrder.output.LineItem>
        </arrayLineItem>
      </OEGetSingleBatchOrderResult>
    </OEGetSingleBatchOrderResponse>
  </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>
    <OEGetSingleBatchOrder xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <batchName>string</batchName>
        <sequenceNumber>int</sequenceNumber>
        <lineSort>string</lineSort>
        <includeHeaderData>boolean</includeHeaderData>
        <includeTotalData>boolean</includeTotalData>
        <includeTaxData>boolean</includeTaxData>
        <includeLineData>boolean</includeLineData>
      </requestObject>
    </OEGetSingleBatchOrder>
  </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>
    <OEGetSingleBatchOrderResponse xmlns="Nxtrend.WS">
      <OEGetSingleBatchOrderResult>
        <errorMessage>string</errorMessage>
        <arrayAvailableField>
          <OEGetSingleBatchOrder.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleBatchOrder.output.AvailableField>
          <OEGetSingleBatchOrder.output.AvailableField>
            <fieldName>string</fieldName>
            <fieldValue>string</fieldValue>
            <sequenceNumber>int</sequenceNumber>
          </OEGetSingleBatchOrder.output.AvailableField>
        </arrayAvailableField>
        <arrayLineItem>
          <OEGetSingleBatchOrder.output.LineItem>
            <batchName>string</batchName>
            <sequenceNumber>int</sequenceNumber>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <productDescription>string</productDescription>
            <productNotesFlag>string</productNotesFlag>
            <commentFlag>string</commentFlag>
            <quantityOrdered>double</quantityOrdered>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <unit>string</unit>
            <progressRecId>int</progressRecId>
            <costPerStockingUnit>double</costPerStockingUnit>
            <specialConversion>int</specialConversion>
            <priceCostPer>string</priceCostPer>
            <specialCostType>string</specialCostType>
            <icSpecRecNo>int</icSpecRecNo>
            <price>double</price>
            <productCost>double</productCost>
            <discountAmount>double</discountAmount>
            <netAmount>double</netAmount>
            <displayPrice>string</displayPrice>
            <displayDiscountAmount>string</displayDiscountAmount>
            <displayNetAmount>string</displayNetAmount>
            <sortField>string</sortField>
          </OEGetSingleBatchOrder.output.LineItem>
          <OEGetSingleBatchOrder.output.LineItem>
            <batchName>string</batchName>
            <sequenceNumber>int</sequenceNumber>
            <lineNumber>int</lineNumber>
            <specialNonStockType>string</specialNonStockType>
            <productCode>string</productCode>
            <productDescription>string</productDescription>
            <productNotesFlag>string</productNotesFlag>
            <commentFlag>string</commentFlag>
            <quantityOrdered>double</quantityOrdered>
            <stockingQuantityOrdered>double</stockingQuantityOrdered>
            <unit>string</unit>
            <progressRecId>int</progressRecId>
            <costPerStockingUnit>double</costPerStockingUnit>
            <specialConversion>int</specialConversion>
            <priceCostPer>string</priceCostPer>
            <specialCostType>string</specialCostType>
            <icSpecRecNo>int</icSpecRecNo>
            <price>double</price>
            <productCost>double</productCost>
            <discountAmount>double</discountAmount>
            <netAmount>double</netAmount>
            <displayPrice>string</displayPrice>
            <displayDiscountAmount>string</displayDiscountAmount>
            <displayNetAmount>string</displayNetAmount>
            <sortField>string</sortField>
          </OEGetSingleBatchOrder.output.LineItem>
        </arrayLineItem>
      </OEGetSingleBatchOrderResult>
    </OEGetSingleBatchOrderResponse>
  </soap12:Body>
</soap12:Envelope>