PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getInventoryForItemWarehouse

Returns item inventory summary for the specified warehouse.

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

<?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>
    <getInventoryForItemWarehouse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Item>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </Item>
      <Warehouse>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </Warehouse>
    </getInventoryForItemWarehouse>
  </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>
    <getInventoryForItemWarehouseResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getInventoryForItemWarehouseResult>
        <OnHandQty>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </OnHandQty>
        <Ordered>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Ordered>
        <Allocated>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Allocated>
        <Details>
          <InventoryDetail>
            <Item xsi:nil="true" />
            <Serialized xsi:nil="true" />
            <Warehouse xsi:nil="true" />
            <Bin xsi:nil="true" />
            <StockType xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </InventoryDetail>
          <InventoryDetail>
            <Item xsi:nil="true" />
            <Serialized xsi:nil="true" />
            <Warehouse xsi:nil="true" />
            <Bin xsi:nil="true" />
            <StockType xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </InventoryDetail>
        </Details>
      </getInventoryForItemWarehouseResult>
    </getInventoryForItemWarehouseResponse>
  </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>
    <getInventoryForItemWarehouse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Item>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </Item>
      <Warehouse>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </Warehouse>
    </getInventoryForItemWarehouse>
  </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>
    <getInventoryForItemWarehouseResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getInventoryForItemWarehouseResult>
        <OnHandQty>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </OnHandQty>
        <Ordered>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Ordered>
        <Allocated>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Allocated>
        <Details>
          <InventoryDetail>
            <Item xsi:nil="true" />
            <Serialized xsi:nil="true" />
            <Warehouse xsi:nil="true" />
            <Bin xsi:nil="true" />
            <StockType xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </InventoryDetail>
          <InventoryDetail>
            <Item xsi:nil="true" />
            <Serialized xsi:nil="true" />
            <Warehouse xsi:nil="true" />
            <Bin xsi:nil="true" />
            <StockType xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </InventoryDetail>
        </Details>
      </getInventoryForItemWarehouseResult>
    </getInventoryForItemWarehouseResponse>
  </soap12:Body>
</soap12:Envelope>