PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getVendorsByName

This function retrieves an array of the complete Vendor Data for any Vendor matching the VendorName supplied.

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

<?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>
    <getVendorsByName xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VendorName>string</VendorName>
    </getVendorsByName>
  </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>
    <getVendorsByNameResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorsByNameResult>
        <VendorData>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <Name>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Name>
          <Address>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Address>
          <City>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </City>
          <State>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </State>
          <Zip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Zip>
          <Country>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Country>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <Phone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Phone>
          <Fax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Fax>
          <Email>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Email>
          <WebSite>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </WebSite>
          <PurchaseContact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseContact>
          <PurchasePhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchasePhone>
          <PurchaseFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseFax>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <EIN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </EIN>
          <VendorAccountNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorAccountNumber>
          <CreditLimit>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </CreditLimit>
          <Do1099>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Do1099>
          <Hold>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hold>
          <OnHoldCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </OnHoldCode>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <VendorOrderTo>
            <VendorOrderTo xsi:nil="true" />
            <VendorOrderTo xsi:nil="true" />
          </VendorOrderTo>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </VendorData>
        <VendorData>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <Name>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Name>
          <Address>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Address>
          <City>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </City>
          <State>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </State>
          <Zip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Zip>
          <Country>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Country>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <Phone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Phone>
          <Fax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Fax>
          <Email>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Email>
          <WebSite>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </WebSite>
          <PurchaseContact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseContact>
          <PurchasePhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchasePhone>
          <PurchaseFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseFax>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <EIN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </EIN>
          <VendorAccountNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorAccountNumber>
          <CreditLimit>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </CreditLimit>
          <Do1099>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Do1099>
          <Hold>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hold>
          <OnHoldCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </OnHoldCode>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <VendorOrderTo>
            <VendorOrderTo xsi:nil="true" />
            <VendorOrderTo xsi:nil="true" />
          </VendorOrderTo>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </VendorData>
      </getVendorsByNameResult>
    </getVendorsByNameResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.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>
    <getVendorsByName xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VendorName>string</VendorName>
    </getVendorsByName>
  </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>
    <getVendorsByNameResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorsByNameResult>
        <VendorData>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <Name>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Name>
          <Address>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Address>
          <City>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </City>
          <State>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </State>
          <Zip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Zip>
          <Country>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Country>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <Phone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Phone>
          <Fax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Fax>
          <Email>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Email>
          <WebSite>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </WebSite>
          <PurchaseContact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseContact>
          <PurchasePhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchasePhone>
          <PurchaseFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseFax>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <EIN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </EIN>
          <VendorAccountNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorAccountNumber>
          <CreditLimit>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </CreditLimit>
          <Do1099>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Do1099>
          <Hold>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hold>
          <OnHoldCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </OnHoldCode>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <VendorOrderTo>
            <VendorOrderTo xsi:nil="true" />
            <VendorOrderTo xsi:nil="true" />
          </VendorOrderTo>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </VendorData>
        <VendorData>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <Name>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Name>
          <Address>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Address>
          <City>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </City>
          <State>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </State>
          <Zip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Zip>
          <Country>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Country>
          <Contact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Contact>
          <Phone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Phone>
          <Fax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Fax>
          <Email>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Email>
          <WebSite>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </WebSite>
          <PurchaseContact>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseContact>
          <PurchasePhone>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchasePhone>
          <PurchaseFax>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PurchaseFax>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <EIN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </EIN>
          <VendorAccountNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorAccountNumber>
          <CreditLimit>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </CreditLimit>
          <Do1099>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Do1099>
          <Hold>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Hold>
          <OnHoldCode>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </OnHoldCode>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <VendorOrderTo>
            <VendorOrderTo xsi:nil="true" />
            <VendorOrderTo xsi:nil="true" />
          </VendorOrderTo>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </VendorData>
      </getVendorsByNameResult>
    </getVendorsByNameResponse>
  </soap12:Body>
</soap12:Envelope>