PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addPurchaseOrder

This function will add a Purchase Order with the data supplied. The return value will contain the new PurchaseOrderID.

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

<?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>
    <addPurchaseOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <PurchaseOrder>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <Vendor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Vendor>
        <Warehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Warehouse>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Notes>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Notes>
        <optDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </optDate>
        <optRequestDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </optRequestDate>
        <DropShipToCustomer>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </DropShipToCustomer>
        <ShipToWarehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipToWarehouse>
        <optShipToCustomer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <optPurchasersUserID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optPurchasersUserID>
        <optShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipMethod>
        <Details>
          <PurchaseOrderDetail>
            <DetailID xsi:nil="true" />
            <PO xsi:nil="true" />
            <Item xsi:nil="true" />
            <Description xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Canceled xsi:nil="true" />
            <Price xsi:nil="true" />
            <DropShipToCustomer xsi:nil="true" />
            <CurrentWarehouse xsi:nil="true" />
            <DefaultWarehouse xsi:nil="true" />
            <DefaultBin xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <optSalesOrder xsi:nil="true" />
            <optDetailBin xsi:nil="true" />
            <Notes xsi:nil="true" />
            <optSalesOrderDetailBin xsi:nil="true" />
            <Status xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <optCustPONumber xsi:nil="true" />
            <optReceived xsi:nil="true" />
            <optVouchered xsi:nil="true" />
            <optItemSerialized xsi:nil="true" />
            <Bins xsi:nil="true" />
          </PurchaseOrderDetail>
          <PurchaseOrderDetail>
            <DetailID xsi:nil="true" />
            <PO xsi:nil="true" />
            <Item xsi:nil="true" />
            <Description xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Canceled xsi:nil="true" />
            <Price xsi:nil="true" />
            <DropShipToCustomer xsi:nil="true" />
            <CurrentWarehouse xsi:nil="true" />
            <DefaultWarehouse xsi:nil="true" />
            <DefaultBin xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <optSalesOrder xsi:nil="true" />
            <optDetailBin xsi:nil="true" />
            <Notes xsi:nil="true" />
            <optSalesOrderDetailBin xsi:nil="true" />
            <Status xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <optCustPONumber xsi:nil="true" />
            <optReceived xsi:nil="true" />
            <optVouchered xsi:nil="true" />
            <optItemSerialized xsi:nil="true" />
            <Bins xsi:nil="true" />
          </PurchaseOrderDetail>
        </Details>
        <optPOMajor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optPOMajor>
        <Message>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Message>
        <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>
      </PurchaseOrder>
    </addPurchaseOrder>
  </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>
    <addPurchaseOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addPurchaseOrderResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addPurchaseOrderResult>
    </addPurchaseOrderResponse>
  </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>
    <addPurchaseOrder xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <PurchaseOrder>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <Vendor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Vendor>
        <Warehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Warehouse>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Notes>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Notes>
        <optDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </optDate>
        <optRequestDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </optRequestDate>
        <DropShipToCustomer>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </DropShipToCustomer>
        <ShipToWarehouse>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipToWarehouse>
        <optShipToCustomer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Status>
        <optPurchasersUserID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </optPurchasersUserID>
        <optShipMethod>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optShipMethod>
        <Details>
          <PurchaseOrderDetail>
            <DetailID xsi:nil="true" />
            <PO xsi:nil="true" />
            <Item xsi:nil="true" />
            <Description xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Canceled xsi:nil="true" />
            <Price xsi:nil="true" />
            <DropShipToCustomer xsi:nil="true" />
            <CurrentWarehouse xsi:nil="true" />
            <DefaultWarehouse xsi:nil="true" />
            <DefaultBin xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <optSalesOrder xsi:nil="true" />
            <optDetailBin xsi:nil="true" />
            <Notes xsi:nil="true" />
            <optSalesOrderDetailBin xsi:nil="true" />
            <Status xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <optCustPONumber xsi:nil="true" />
            <optReceived xsi:nil="true" />
            <optVouchered xsi:nil="true" />
            <optItemSerialized xsi:nil="true" />
            <Bins xsi:nil="true" />
          </PurchaseOrderDetail>
          <PurchaseOrderDetail>
            <DetailID xsi:nil="true" />
            <PO xsi:nil="true" />
            <Item xsi:nil="true" />
            <Description xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <Canceled xsi:nil="true" />
            <Price xsi:nil="true" />
            <DropShipToCustomer xsi:nil="true" />
            <CurrentWarehouse xsi:nil="true" />
            <DefaultWarehouse xsi:nil="true" />
            <DefaultBin xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <optSalesOrder xsi:nil="true" />
            <optDetailBin xsi:nil="true" />
            <Notes xsi:nil="true" />
            <optSalesOrderDetailBin xsi:nil="true" />
            <Status xsi:nil="true" />
            <optSalesOrderDetailBins xsi:nil="true" />
            <optCustPONumber xsi:nil="true" />
            <optReceived xsi:nil="true" />
            <optVouchered xsi:nil="true" />
            <optItemSerialized xsi:nil="true" />
            <Bins xsi:nil="true" />
          </PurchaseOrderDetail>
        </Details>
        <optPOMajor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </optPOMajor>
        <Message>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Message>
        <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>
      </PurchaseOrder>
    </addPurchaseOrder>
  </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>
    <addPurchaseOrderResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addPurchaseOrderResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addPurchaseOrderResult>
    </addPurchaseOrderResponse>
  </soap12:Body>
</soap12:Envelope>