PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getSOShipment

Returns all of the shipments for a given Sales Order.

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

<?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>
    <getSOShipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SONumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </SONumber>
    </getSOShipment>
  </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>
    <getSOShipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSOShipmentResult>
        <ShipmentData>
          <ShipmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipmentID>
          <FulFillmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </FulFillmentID>
          <SOID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </SOID>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <DeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DeliveryDate>
          <EstDeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </EstDeliveryDate>
          <ShipMethodID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethodID>
          <User>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </User>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Freight>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Freight>
          <FreightCost>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </FreightCost>
          <Details>
            <ShipmentDetail xsi:nil="true" />
            <ShipmentDetail xsi:nil="true" />
          </Details>
          <PackageDetails>
            <ShipmentPackageDetail xsi:nil="true" />
            <ShipmentPackageDetail xsi:nil="true" />
          </PackageDetails>
        </ShipmentData>
        <ShipmentData>
          <ShipmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipmentID>
          <FulFillmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </FulFillmentID>
          <SOID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </SOID>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <DeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DeliveryDate>
          <EstDeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </EstDeliveryDate>
          <ShipMethodID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethodID>
          <User>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </User>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Freight>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Freight>
          <FreightCost>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </FreightCost>
          <Details>
            <ShipmentDetail xsi:nil="true" />
            <ShipmentDetail xsi:nil="true" />
          </Details>
          <PackageDetails>
            <ShipmentPackageDetail xsi:nil="true" />
            <ShipmentPackageDetail xsi:nil="true" />
          </PackageDetails>
        </ShipmentData>
      </getSOShipmentResult>
    </getSOShipmentResponse>
  </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>
    <getSOShipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <SONumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </SONumber>
    </getSOShipment>
  </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>
    <getSOShipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSOShipmentResult>
        <ShipmentData>
          <ShipmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipmentID>
          <FulFillmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </FulFillmentID>
          <SOID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </SOID>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <DeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DeliveryDate>
          <EstDeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </EstDeliveryDate>
          <ShipMethodID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethodID>
          <User>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </User>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Freight>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Freight>
          <FreightCost>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </FreightCost>
          <Details>
            <ShipmentDetail xsi:nil="true" />
            <ShipmentDetail xsi:nil="true" />
          </Details>
          <PackageDetails>
            <ShipmentPackageDetail xsi:nil="true" />
            <ShipmentPackageDetail xsi:nil="true" />
          </PackageDetails>
        </ShipmentData>
        <ShipmentData>
          <ShipmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipmentID>
          <FulFillmentID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </FulFillmentID>
          <SOID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </SOID>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <DeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DeliveryDate>
          <EstDeliveryDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </EstDeliveryDate>
          <ShipMethodID>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethodID>
          <User>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </User>
          <Active>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </Active>
          <Freight>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Freight>
          <FreightCost>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </FreightCost>
          <Details>
            <ShipmentDetail xsi:nil="true" />
            <ShipmentDetail xsi:nil="true" />
          </Details>
          <PackageDetails>
            <ShipmentPackageDetail xsi:nil="true" />
            <ShipmentPackageDetail xsi:nil="true" />
          </PackageDetails>
        </ShipmentData>
      </getSOShipmentResult>
    </getSOShipmentResponse>
  </soap12:Body>
</soap12:Envelope>