PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getVendor

This function retrieves the complete Vendor Data for the Vendor Number Supplied. The input parameter may contain the Vendor ID given in the (ID) field and/or Vendor Number given in the (Code) Field.

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

<?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>
    <getVendor xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VendorNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </VendorNumber>
    </getVendor>
  </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>
    <getVendorResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorResult>
        <VendorNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <ShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <VendorOrderTo>
          <VendorOrderTo>
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Phone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Preferred xsi:nil="true" />
          </VendorOrderTo>
          <VendorOrderTo>
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Phone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Preferred xsi:nil="true" />
          </VendorOrderTo>
        </VendorOrderTo>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </getVendorResult>
    </getVendorResponse>
  </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>
    <getVendor xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VendorNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </VendorNumber>
    </getVendor>
  </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>
    <getVendorResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getVendorResult>
        <VendorNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <ShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </OnHoldCode>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <VendorOrderTo>
          <VendorOrderTo>
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Phone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Preferred xsi:nil="true" />
          </VendorOrderTo>
          <VendorOrderTo>
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <Zip xsi:nil="true" />
            <Country xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Phone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Email xsi:nil="true" />
            <WebSite xsi:nil="true" />
            <Preferred xsi:nil="true" />
          </VendorOrderTo>
        </VendorOrderTo>
        <CustomProperties>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
          <CustomProperty>
            <ID>int</ID>
            <Name>string</Name>
            <Value>string</Value>
            <IDVal>int</IDVal>
          </CustomProperty>
        </CustomProperties>
      </getVendorResult>
    </getVendorResponse>
  </soap12:Body>
</soap12:Envelope>