SxApiService Web Service

SxApiService

Click here for a complete list of operations.

ARGetCustomerListV2

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

<?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>
    <ARGetCustomerListV2 xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <name>string</name>
        <lookupName>string</lookupName>
        <customerNumber>double</customerNumber>
        <city>string</city>
        <state>string</state>
        <postalCode>string</postalCode>
        <phone>string</phone>
        <includeInactiveCustomers>boolean</includeInactiveCustomers>
        <lastReview>
          <year>int</year>
          <month>int</month>
          <date>int</date>
        </lastReview>
        <lastReviewComparison>string</lastReviewComparison>
        <nextReview>
          <year>int</year>
          <month>int</month>
          <date>int</date>
        </nextReview>
        <nextReviewComparison>string</nextReviewComparison>
        <balance>double</balance>
        <balanceComparison>string</balanceComparison>
        <summaryType>string</summaryType>
        <summaryFromAmount>double</summaryFromAmount>
        <summaryToAmount>double</summaryToAmount>
        <keyWord1>string</keyWord1>
        <keyWord2>string</keyWord2>
        <keyWord3>string</keyWord3>
        <keyWord4>string</keyWord4>
        <keyWord5>string</keyWord5>
        <sort>string</sort>
        <recordLimit>int</recordLimit>
      </requestObject>
    </ARGetCustomerListV2>
  </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>
    <ARGetCustomerListV2Response xmlns="Nxtrend.WS">
      <ARGetCustomerListV2Result>
        <errorMessage>string</errorMessage>
        <moreRecordsAvailable>boolean</moreRecordsAvailable>
        <totalSalesYTD>double</totalSalesYTD>
        <totalCostYTD>double</totalCostYTD>
        <totalMarginYTD>double</totalMarginYTD>
        <totalLastYearSalesYTD>double</totalLastYearSalesYTD>
        <totalLastYearCostYTD>double</totalLastYearCostYTD>
        <totalLastYearMarginYTD>double</totalLastYearMarginYTD>
        <totalPeriodBalance1>double</totalPeriodBalance1>
        <totalPeriodBalance2>double</totalPeriodBalance2>
        <totalPeriodBalance3>double</totalPeriodBalance3>
        <totalPeriodBalance4>double</totalPeriodBalance4>
        <totalPeriodBalance5>double</totalPeriodBalance5>
        <arrayCustomer>
          <ARGetCustomerListV2.output.Customer>
            <customerNumber>double</customerNumber>
            <shipTo>string</shipTo>
            <name>string</name>
            <address1>string</address1>
            <address2>string</address2>
            <city>string</city>
            <state>string</state>
            <postalCode>string</postalCode>
            <orderBalance>double</orderBalance>
            <totalBalance>double</totalBalance>
            <sortField>string</sortField>
            <salesYTD>double</salesYTD>
            <costYTD>double</costYTD>
            <marginYTD>double</marginYTD>
            <lastYearSalesYTD>double</lastYearSalesYTD>
            <lastYearCostYTD>double</lastYearCostYTD>
            <lastYearMarginYTD>double</lastYearMarginYTD>
            <periodBalance1>double</periodBalance1>
            <periodBalance2>double</periodBalance2>
            <periodBalance3>double</periodBalance3>
            <periodBalance4>double</periodBalance4>
            <periodBalance5>double</periodBalance5>
          </ARGetCustomerListV2.output.Customer>
          <ARGetCustomerListV2.output.Customer>
            <customerNumber>double</customerNumber>
            <shipTo>string</shipTo>
            <name>string</name>
            <address1>string</address1>
            <address2>string</address2>
            <city>string</city>
            <state>string</state>
            <postalCode>string</postalCode>
            <orderBalance>double</orderBalance>
            <totalBalance>double</totalBalance>
            <sortField>string</sortField>
            <salesYTD>double</salesYTD>
            <costYTD>double</costYTD>
            <marginYTD>double</marginYTD>
            <lastYearSalesYTD>double</lastYearSalesYTD>
            <lastYearCostYTD>double</lastYearCostYTD>
            <lastYearMarginYTD>double</lastYearMarginYTD>
            <periodBalance1>double</periodBalance1>
            <periodBalance2>double</periodBalance2>
            <periodBalance3>double</periodBalance3>
            <periodBalance4>double</periodBalance4>
            <periodBalance5>double</periodBalance5>
          </ARGetCustomerListV2.output.Customer>
        </arrayCustomer>
      </ARGetCustomerListV2Result>
    </ARGetCustomerListV2Response>
  </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>
    <ARGetCustomerListV2 xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <name>string</name>
        <lookupName>string</lookupName>
        <customerNumber>double</customerNumber>
        <city>string</city>
        <state>string</state>
        <postalCode>string</postalCode>
        <phone>string</phone>
        <includeInactiveCustomers>boolean</includeInactiveCustomers>
        <lastReview>
          <year>int</year>
          <month>int</month>
          <date>int</date>
        </lastReview>
        <lastReviewComparison>string</lastReviewComparison>
        <nextReview>
          <year>int</year>
          <month>int</month>
          <date>int</date>
        </nextReview>
        <nextReviewComparison>string</nextReviewComparison>
        <balance>double</balance>
        <balanceComparison>string</balanceComparison>
        <summaryType>string</summaryType>
        <summaryFromAmount>double</summaryFromAmount>
        <summaryToAmount>double</summaryToAmount>
        <keyWord1>string</keyWord1>
        <keyWord2>string</keyWord2>
        <keyWord3>string</keyWord3>
        <keyWord4>string</keyWord4>
        <keyWord5>string</keyWord5>
        <sort>string</sort>
        <recordLimit>int</recordLimit>
      </requestObject>
    </ARGetCustomerListV2>
  </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>
    <ARGetCustomerListV2Response xmlns="Nxtrend.WS">
      <ARGetCustomerListV2Result>
        <errorMessage>string</errorMessage>
        <moreRecordsAvailable>boolean</moreRecordsAvailable>
        <totalSalesYTD>double</totalSalesYTD>
        <totalCostYTD>double</totalCostYTD>
        <totalMarginYTD>double</totalMarginYTD>
        <totalLastYearSalesYTD>double</totalLastYearSalesYTD>
        <totalLastYearCostYTD>double</totalLastYearCostYTD>
        <totalLastYearMarginYTD>double</totalLastYearMarginYTD>
        <totalPeriodBalance1>double</totalPeriodBalance1>
        <totalPeriodBalance2>double</totalPeriodBalance2>
        <totalPeriodBalance3>double</totalPeriodBalance3>
        <totalPeriodBalance4>double</totalPeriodBalance4>
        <totalPeriodBalance5>double</totalPeriodBalance5>
        <arrayCustomer>
          <ARGetCustomerListV2.output.Customer>
            <customerNumber>double</customerNumber>
            <shipTo>string</shipTo>
            <name>string</name>
            <address1>string</address1>
            <address2>string</address2>
            <city>string</city>
            <state>string</state>
            <postalCode>string</postalCode>
            <orderBalance>double</orderBalance>
            <totalBalance>double</totalBalance>
            <sortField>string</sortField>
            <salesYTD>double</salesYTD>
            <costYTD>double</costYTD>
            <marginYTD>double</marginYTD>
            <lastYearSalesYTD>double</lastYearSalesYTD>
            <lastYearCostYTD>double</lastYearCostYTD>
            <lastYearMarginYTD>double</lastYearMarginYTD>
            <periodBalance1>double</periodBalance1>
            <periodBalance2>double</periodBalance2>
            <periodBalance3>double</periodBalance3>
            <periodBalance4>double</periodBalance4>
            <periodBalance5>double</periodBalance5>
          </ARGetCustomerListV2.output.Customer>
          <ARGetCustomerListV2.output.Customer>
            <customerNumber>double</customerNumber>
            <shipTo>string</shipTo>
            <name>string</name>
            <address1>string</address1>
            <address2>string</address2>
            <city>string</city>
            <state>string</state>
            <postalCode>string</postalCode>
            <orderBalance>double</orderBalance>
            <totalBalance>double</totalBalance>
            <sortField>string</sortField>
            <salesYTD>double</salesYTD>
            <costYTD>double</costYTD>
            <marginYTD>double</marginYTD>
            <lastYearSalesYTD>double</lastYearSalesYTD>
            <lastYearCostYTD>double</lastYearCostYTD>
            <lastYearMarginYTD>double</lastYearMarginYTD>
            <periodBalance1>double</periodBalance1>
            <periodBalance2>double</periodBalance2>
            <periodBalance3>double</periodBalance3>
            <periodBalance4>double</periodBalance4>
            <periodBalance5>double</periodBalance5>
          </ARGetCustomerListV2.output.Customer>
        </arrayCustomer>
      </ARGetCustomerListV2Result>
    </ARGetCustomerListV2Response>
  </soap12:Body>
</soap12:Envelope>