PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getPurchaseOrdersByVendor

This function will return a list of open Purchase Orders for the specified vendor.

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

<?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>
    <getPurchaseOrdersByVendor xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <vendor>string</vendor>
    </getPurchaseOrdersByVendor>
  </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>
    <getPurchaseOrdersByVendorResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getPurchaseOrdersByVendorResult>
        <PurchaseOrderData>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <Customer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Customer>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <Warehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Warehouse>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Notes>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Notes>
          <optDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optDate>
          <optRequestDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optRequestDate>
          <DropShipToCustomer>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </DropShipToCustomer>
          <ShipToWarehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToWarehouse>
          <optShipToCustomer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipToCustomer>
          <optShipToName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToName>
          <optShipToATTN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToATTN>
          <optShipToStreet>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToStreet>
          <optShipToCity>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCity>
          <optShipToState>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToState>
          <optShipToZip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToZip>
          <optShipToCountry>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCountry>
          <optShipToTypeID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </optShipToTypeID>
          <Locked>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Locked>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Status>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Status>
          <optPurchasersUserID>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optPurchasersUserID>
          <optShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipMethod>
          <Details>
            <PurchaseOrderDetail xsi:nil="true" />
            <PurchaseOrderDetail xsi:nil="true" />
          </Details>
          <optPOMajor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optPOMajor>
          <Message>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Message>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </PurchaseOrderData>
        <PurchaseOrderData>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <Customer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Customer>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <Warehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Warehouse>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Notes>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Notes>
          <optDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optDate>
          <optRequestDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optRequestDate>
          <DropShipToCustomer>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </DropShipToCustomer>
          <ShipToWarehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToWarehouse>
          <optShipToCustomer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipToCustomer>
          <optShipToName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToName>
          <optShipToATTN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToATTN>
          <optShipToStreet>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToStreet>
          <optShipToCity>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCity>
          <optShipToState>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToState>
          <optShipToZip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToZip>
          <optShipToCountry>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCountry>
          <optShipToTypeID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </optShipToTypeID>
          <Locked>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Locked>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Status>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Status>
          <optPurchasersUserID>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optPurchasersUserID>
          <optShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipMethod>
          <Details>
            <PurchaseOrderDetail xsi:nil="true" />
            <PurchaseOrderDetail xsi:nil="true" />
          </Details>
          <optPOMajor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optPOMajor>
          <Message>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Message>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </PurchaseOrderData>
      </getPurchaseOrdersByVendorResult>
    </getPurchaseOrdersByVendorResponse>
  </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>
    <getPurchaseOrdersByVendor xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <vendor>string</vendor>
    </getPurchaseOrdersByVendor>
  </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>
    <getPurchaseOrdersByVendorResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getPurchaseOrdersByVendorResult>
        <PurchaseOrderData>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <Customer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Customer>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <Warehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Warehouse>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Notes>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Notes>
          <optDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optDate>
          <optRequestDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optRequestDate>
          <DropShipToCustomer>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </DropShipToCustomer>
          <ShipToWarehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToWarehouse>
          <optShipToCustomer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipToCustomer>
          <optShipToName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToName>
          <optShipToATTN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToATTN>
          <optShipToStreet>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToStreet>
          <optShipToCity>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCity>
          <optShipToState>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToState>
          <optShipToZip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToZip>
          <optShipToCountry>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCountry>
          <optShipToTypeID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </optShipToTypeID>
          <Locked>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Locked>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Status>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Status>
          <optPurchasersUserID>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optPurchasersUserID>
          <optShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipMethod>
          <Details>
            <PurchaseOrderDetail xsi:nil="true" />
            <PurchaseOrderDetail xsi:nil="true" />
          </Details>
          <optPOMajor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optPOMajor>
          <Message>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Message>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </PurchaseOrderData>
        <PurchaseOrderData>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <Customer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Customer>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <Warehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Warehouse>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Notes>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Notes>
          <optDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optDate>
          <optRequestDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </optRequestDate>
          <DropShipToCustomer>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </DropShipToCustomer>
          <ShipToWarehouse>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipToWarehouse>
          <optShipToCustomer>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipToCustomer>
          <optShipToName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToName>
          <optShipToATTN>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToATTN>
          <optShipToStreet>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToStreet>
          <optShipToCity>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCity>
          <optShipToState>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToState>
          <optShipToZip>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToZip>
          <optShipToCountry>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optShipToCountry>
          <optShipToTypeID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </optShipToTypeID>
          <Locked>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Locked>
          <Remarks>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Remarks>
          <Status>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Status>
          <optPurchasersUserID>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </optPurchasersUserID>
          <optShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optShipMethod>
          <Details>
            <PurchaseOrderDetail xsi:nil="true" />
            <PurchaseOrderDetail xsi:nil="true" />
          </Details>
          <optPOMajor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </optPOMajor>
          <Message>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Message>
          <CustomProperties>
            <CustomProperty xsi:nil="true" />
            <CustomProperty xsi:nil="true" />
          </CustomProperties>
        </PurchaseOrderData>
      </getPurchaseOrdersByVendorResult>
    </getPurchaseOrdersByVendorResponse>
  </soap12:Body>
</soap12:Envelope>