SxApiService Web Service

SxApiService

Click here for a complete list of operations.

SFGetGenericData

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

<?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>
    <SFGetGenericData xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <environmentID>string</environmentID>
        <getCompanies>string</getCompanies>
        <getWarehoues>string</getWarehoues>
        <getCountries>string</getCountries>
        <getStates>string</getStates>
        <getCarrierCodes>string</getCarrierCodes>
        <getPaymentCodes>string</getPaymentCodes>
        <getHoldCodes>string</getHoldCodes>
        <getCorporateGroups>string</getCorporateGroups>
        <getFreightRates>string</getFreightRates>
        <getPostalZones>string</getPostalZones>
        <getAlternateWarehouses>string</getAlternateWarehouses>
        <getCurrencyCodes>string</getCurrencyCodes>
      </requestObject>
    </SFGetGenericData>
  </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>
    <SFGetGenericDataResponse xmlns="Nxtrend.WS">
      <SFGetGenericDataResult>
        <errorMessage>string</errorMessage>
        <arrayCompany>
          <SFGetGenericData.output.Company>
            <companyNumber>int</companyNumber>
            <companyName>string</companyName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Company>
          <SFGetGenericData.output.Company>
            <companyNumber>int</companyNumber>
            <companyName>string</companyName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Company>
        </arrayCompany>
        <arrayWhse>
          <SFGetGenericData.output.Whse>
            <companyNumber>int</companyNumber>
            <warehouseID>string</warehouseID>
            <warehouseName>string</warehouseName>
            <warehousePricingLevel>string</warehousePricingLevel>
            <extraData>string</extraData>
          </SFGetGenericData.output.Whse>
          <SFGetGenericData.output.Whse>
            <companyNumber>int</companyNumber>
            <warehouseID>string</warehouseID>
            <warehouseName>string</warehouseName>
            <warehousePricingLevel>string</warehousePricingLevel>
            <extraData>string</extraData>
          </SFGetGenericData.output.Whse>
        </arrayWhse>
        <arrayCountry>
          <SFGetGenericData.output.Country>
            <companyNumber>int</companyNumber>
            <countryID>string</countryID>
            <countryName>string</countryName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Country>
          <SFGetGenericData.output.Country>
            <companyNumber>int</companyNumber>
            <countryID>string</countryID>
            <countryName>string</countryName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Country>
        </arrayCountry>
        <arrayState>
          <SFGetGenericData.output.State>
            <companyNumber>int</companyNumber>
            <stateID>string</stateID>
            <stateName>string</stateName>
            <extraData>string</extraData>
          </SFGetGenericData.output.State>
          <SFGetGenericData.output.State>
            <companyNumber>int</companyNumber>
            <stateID>string</stateID>
            <stateName>string</stateName>
            <extraData>string</extraData>
          </SFGetGenericData.output.State>
        </arrayState>
        <arrayCarriercode>
          <SFGetGenericData.output.Carriercode>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <carrierCodeName>string</carrierCodeName>
            <preventWebUsage>string</preventWebUsage>
            <extraData>string</extraData>
          </SFGetGenericData.output.Carriercode>
          <SFGetGenericData.output.Carriercode>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <carrierCodeName>string</carrierCodeName>
            <preventWebUsage>string</preventWebUsage>
            <extraData>string</extraData>
          </SFGetGenericData.output.Carriercode>
        </arrayCarriercode>
        <arrayPaymentcode>
          <SFGetGenericData.output.Paymentcode>
            <companyNumber>int</companyNumber>
            <paymentCode>string</paymentCode>
            <paymentCodeName>string</paymentCodeName>
            <cvv2Required>string</cvv2Required>
            <extraData>string</extraData>
          </SFGetGenericData.output.Paymentcode>
          <SFGetGenericData.output.Paymentcode>
            <companyNumber>int</companyNumber>
            <paymentCode>string</paymentCode>
            <paymentCodeName>string</paymentCodeName>
            <cvv2Required>string</cvv2Required>
            <extraData>string</extraData>
          </SFGetGenericData.output.Paymentcode>
        </arrayPaymentcode>
        <arrayHoldcode>
          <SFGetGenericData.output.Holdcode>
            <companyNumber>int</companyNumber>
            <holdCode>string</holdCode>
            <holdCodeName>string</holdCodeName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Holdcode>
          <SFGetGenericData.output.Holdcode>
            <companyNumber>int</companyNumber>
            <holdCode>string</holdCode>
            <holdCodeName>string</holdCodeName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Holdcode>
        </arrayHoldcode>
        <arrayCorporategroup>
          <SFGetGenericData.output.Corporategroup>
            <companyNumber>int</companyNumber>
            <corporateGroupID>string</corporateGroupID>
            <corporateGroupDescription>string</corporateGroupDescription>
            <extraData>string</extraData>
          </SFGetGenericData.output.Corporategroup>
          <SFGetGenericData.output.Corporategroup>
            <companyNumber>int</companyNumber>
            <corporateGroupID>string</corporateGroupID>
            <corporateGroupDescription>string</corporateGroupDescription>
            <extraData>string</extraData>
          </SFGetGenericData.output.Corporategroup>
        </arrayCorporategroup>
        <arrayFreightrate>
          <SFGetGenericData.output.Freightrate>
            <companyNumber>int</companyNumber>
            <freightMethod>string</freightMethod>
            <carrierCode>string</carrierCode>
            <currencyCode>string</currencyCode>
            <zoneCode>string</zoneCode>
            <warehouseID>string</warehouseID>
            <totalWeight>double</totalWeight>
            <totalValue>double</totalValue>
            <freightChargeAmount>double</freightChargeAmount>
            <extraData>string</extraData>
          </SFGetGenericData.output.Freightrate>
          <SFGetGenericData.output.Freightrate>
            <companyNumber>int</companyNumber>
            <freightMethod>string</freightMethod>
            <carrierCode>string</carrierCode>
            <currencyCode>string</currencyCode>
            <zoneCode>string</zoneCode>
            <warehouseID>string</warehouseID>
            <totalWeight>double</totalWeight>
            <totalValue>double</totalValue>
            <freightChargeAmount>double</freightChargeAmount>
            <extraData>string</extraData>
          </SFGetGenericData.output.Freightrate>
        </arrayFreightrate>
        <arrayPostalzone>
          <SFGetGenericData.output.Postalzone>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <warehouseID>string</warehouseID>
            <shipCountry>string</shipCountry>
            <zoneCode>string</zoneCode>
            <fromPostalCode>string</fromPostalCode>
            <toPostalCode>string</toPostalCode>
            <extraData>string</extraData>
          </SFGetGenericData.output.Postalzone>
          <SFGetGenericData.output.Postalzone>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <warehouseID>string</warehouseID>
            <shipCountry>string</shipCountry>
            <zoneCode>string</zoneCode>
            <fromPostalCode>string</fromPostalCode>
            <toPostalCode>string</toPostalCode>
            <extraData>string</extraData>
          </SFGetGenericData.output.Postalzone>
        </arrayPostalzone>
        <arrayAlternatewhse>
          <SFGetGenericData.output.Alternatewhse>
            <companyNumber>int</companyNumber>
            <warehouseShippingSequence>string</warehouseShippingSequence>
            <warehouseList>string</warehouseList>
            <extraData>string</extraData>
          </SFGetGenericData.output.Alternatewhse>
          <SFGetGenericData.output.Alternatewhse>
            <companyNumber>int</companyNumber>
            <warehouseShippingSequence>string</warehouseShippingSequence>
            <warehouseList>string</warehouseList>
            <extraData>string</extraData>
          </SFGetGenericData.output.Alternatewhse>
        </arrayAlternatewhse>
        <arrayCurrencycode>
          <SFGetGenericData.output.Currencycode>
            <companyNumber>int</companyNumber>
            <currencyCode>string</currencyCode>
            <currencyDescription>string</currencyDescription>
            <currencySymbol>string</currencySymbol>
            <extraData>string</extraData>
          </SFGetGenericData.output.Currencycode>
          <SFGetGenericData.output.Currencycode>
            <companyNumber>int</companyNumber>
            <currencyCode>string</currencyCode>
            <currencyDescription>string</currencyDescription>
            <currencySymbol>string</currencySymbol>
            <extraData>string</extraData>
          </SFGetGenericData.output.Currencycode>
        </arrayCurrencycode>
      </SFGetGenericDataResult>
    </SFGetGenericDataResponse>
  </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>
    <SFGetGenericData xmlns="Nxtrend.WS">
      <connectString>string</connectString>
      <userCode>string</userCode>
      <requestObject>
        <environmentID>string</environmentID>
        <getCompanies>string</getCompanies>
        <getWarehoues>string</getWarehoues>
        <getCountries>string</getCountries>
        <getStates>string</getStates>
        <getCarrierCodes>string</getCarrierCodes>
        <getPaymentCodes>string</getPaymentCodes>
        <getHoldCodes>string</getHoldCodes>
        <getCorporateGroups>string</getCorporateGroups>
        <getFreightRates>string</getFreightRates>
        <getPostalZones>string</getPostalZones>
        <getAlternateWarehouses>string</getAlternateWarehouses>
        <getCurrencyCodes>string</getCurrencyCodes>
      </requestObject>
    </SFGetGenericData>
  </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>
    <SFGetGenericDataResponse xmlns="Nxtrend.WS">
      <SFGetGenericDataResult>
        <errorMessage>string</errorMessage>
        <arrayCompany>
          <SFGetGenericData.output.Company>
            <companyNumber>int</companyNumber>
            <companyName>string</companyName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Company>
          <SFGetGenericData.output.Company>
            <companyNumber>int</companyNumber>
            <companyName>string</companyName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Company>
        </arrayCompany>
        <arrayWhse>
          <SFGetGenericData.output.Whse>
            <companyNumber>int</companyNumber>
            <warehouseID>string</warehouseID>
            <warehouseName>string</warehouseName>
            <warehousePricingLevel>string</warehousePricingLevel>
            <extraData>string</extraData>
          </SFGetGenericData.output.Whse>
          <SFGetGenericData.output.Whse>
            <companyNumber>int</companyNumber>
            <warehouseID>string</warehouseID>
            <warehouseName>string</warehouseName>
            <warehousePricingLevel>string</warehousePricingLevel>
            <extraData>string</extraData>
          </SFGetGenericData.output.Whse>
        </arrayWhse>
        <arrayCountry>
          <SFGetGenericData.output.Country>
            <companyNumber>int</companyNumber>
            <countryID>string</countryID>
            <countryName>string</countryName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Country>
          <SFGetGenericData.output.Country>
            <companyNumber>int</companyNumber>
            <countryID>string</countryID>
            <countryName>string</countryName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Country>
        </arrayCountry>
        <arrayState>
          <SFGetGenericData.output.State>
            <companyNumber>int</companyNumber>
            <stateID>string</stateID>
            <stateName>string</stateName>
            <extraData>string</extraData>
          </SFGetGenericData.output.State>
          <SFGetGenericData.output.State>
            <companyNumber>int</companyNumber>
            <stateID>string</stateID>
            <stateName>string</stateName>
            <extraData>string</extraData>
          </SFGetGenericData.output.State>
        </arrayState>
        <arrayCarriercode>
          <SFGetGenericData.output.Carriercode>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <carrierCodeName>string</carrierCodeName>
            <preventWebUsage>string</preventWebUsage>
            <extraData>string</extraData>
          </SFGetGenericData.output.Carriercode>
          <SFGetGenericData.output.Carriercode>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <carrierCodeName>string</carrierCodeName>
            <preventWebUsage>string</preventWebUsage>
            <extraData>string</extraData>
          </SFGetGenericData.output.Carriercode>
        </arrayCarriercode>
        <arrayPaymentcode>
          <SFGetGenericData.output.Paymentcode>
            <companyNumber>int</companyNumber>
            <paymentCode>string</paymentCode>
            <paymentCodeName>string</paymentCodeName>
            <cvv2Required>string</cvv2Required>
            <extraData>string</extraData>
          </SFGetGenericData.output.Paymentcode>
          <SFGetGenericData.output.Paymentcode>
            <companyNumber>int</companyNumber>
            <paymentCode>string</paymentCode>
            <paymentCodeName>string</paymentCodeName>
            <cvv2Required>string</cvv2Required>
            <extraData>string</extraData>
          </SFGetGenericData.output.Paymentcode>
        </arrayPaymentcode>
        <arrayHoldcode>
          <SFGetGenericData.output.Holdcode>
            <companyNumber>int</companyNumber>
            <holdCode>string</holdCode>
            <holdCodeName>string</holdCodeName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Holdcode>
          <SFGetGenericData.output.Holdcode>
            <companyNumber>int</companyNumber>
            <holdCode>string</holdCode>
            <holdCodeName>string</holdCodeName>
            <extraData>string</extraData>
          </SFGetGenericData.output.Holdcode>
        </arrayHoldcode>
        <arrayCorporategroup>
          <SFGetGenericData.output.Corporategroup>
            <companyNumber>int</companyNumber>
            <corporateGroupID>string</corporateGroupID>
            <corporateGroupDescription>string</corporateGroupDescription>
            <extraData>string</extraData>
          </SFGetGenericData.output.Corporategroup>
          <SFGetGenericData.output.Corporategroup>
            <companyNumber>int</companyNumber>
            <corporateGroupID>string</corporateGroupID>
            <corporateGroupDescription>string</corporateGroupDescription>
            <extraData>string</extraData>
          </SFGetGenericData.output.Corporategroup>
        </arrayCorporategroup>
        <arrayFreightrate>
          <SFGetGenericData.output.Freightrate>
            <companyNumber>int</companyNumber>
            <freightMethod>string</freightMethod>
            <carrierCode>string</carrierCode>
            <currencyCode>string</currencyCode>
            <zoneCode>string</zoneCode>
            <warehouseID>string</warehouseID>
            <totalWeight>double</totalWeight>
            <totalValue>double</totalValue>
            <freightChargeAmount>double</freightChargeAmount>
            <extraData>string</extraData>
          </SFGetGenericData.output.Freightrate>
          <SFGetGenericData.output.Freightrate>
            <companyNumber>int</companyNumber>
            <freightMethod>string</freightMethod>
            <carrierCode>string</carrierCode>
            <currencyCode>string</currencyCode>
            <zoneCode>string</zoneCode>
            <warehouseID>string</warehouseID>
            <totalWeight>double</totalWeight>
            <totalValue>double</totalValue>
            <freightChargeAmount>double</freightChargeAmount>
            <extraData>string</extraData>
          </SFGetGenericData.output.Freightrate>
        </arrayFreightrate>
        <arrayPostalzone>
          <SFGetGenericData.output.Postalzone>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <warehouseID>string</warehouseID>
            <shipCountry>string</shipCountry>
            <zoneCode>string</zoneCode>
            <fromPostalCode>string</fromPostalCode>
            <toPostalCode>string</toPostalCode>
            <extraData>string</extraData>
          </SFGetGenericData.output.Postalzone>
          <SFGetGenericData.output.Postalzone>
            <companyNumber>int</companyNumber>
            <carrierCode>string</carrierCode>
            <warehouseID>string</warehouseID>
            <shipCountry>string</shipCountry>
            <zoneCode>string</zoneCode>
            <fromPostalCode>string</fromPostalCode>
            <toPostalCode>string</toPostalCode>
            <extraData>string</extraData>
          </SFGetGenericData.output.Postalzone>
        </arrayPostalzone>
        <arrayAlternatewhse>
          <SFGetGenericData.output.Alternatewhse>
            <companyNumber>int</companyNumber>
            <warehouseShippingSequence>string</warehouseShippingSequence>
            <warehouseList>string</warehouseList>
            <extraData>string</extraData>
          </SFGetGenericData.output.Alternatewhse>
          <SFGetGenericData.output.Alternatewhse>
            <companyNumber>int</companyNumber>
            <warehouseShippingSequence>string</warehouseShippingSequence>
            <warehouseList>string</warehouseList>
            <extraData>string</extraData>
          </SFGetGenericData.output.Alternatewhse>
        </arrayAlternatewhse>
        <arrayCurrencycode>
          <SFGetGenericData.output.Currencycode>
            <companyNumber>int</companyNumber>
            <currencyCode>string</currencyCode>
            <currencyDescription>string</currencyDescription>
            <currencySymbol>string</currencySymbol>
            <extraData>string</extraData>
          </SFGetGenericData.output.Currencycode>
          <SFGetGenericData.output.Currencycode>
            <companyNumber>int</companyNumber>
            <currencyCode>string</currencyCode>
            <currencyDescription>string</currencyDescription>
            <currencySymbol>string</currencySymbol>
            <extraData>string</extraData>
          </SFGetGenericData.output.Currencycode>
        </arrayCurrencycode>
      </SFGetGenericDataResult>
    </SFGetGenericDataResponse>
  </soap12:Body>
</soap12:Envelope>