PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addShipment

This function will add a Shipment record with the data supplied. The result data from this function will be in the same format as the input parameters and contain the new Shipment and FulFillment values.

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

<?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>
    <addShipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Shipment>
        <ShipmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipmentID>
        <FulFillmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </FulFillmentID>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <DeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DeliveryDate>
        <EstDeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </EstDeliveryDate>
        <ShipMethodID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
          <ShipmentDetail>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
        </Details>
        <PackageDetails>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
        </PackageDetails>
      </Shipment>
    </addShipment>
  </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>
    <addShipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addShipmentResult>
        <ShipmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipmentID>
        <FulFillmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </FulFillmentID>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <DeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DeliveryDate>
        <EstDeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </EstDeliveryDate>
        <ShipMethodID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
          <ShipmentDetail>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
        </Details>
        <PackageDetails>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
        </PackageDetails>
      </addShipmentResult>
    </addShipmentResponse>
  </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>
    <addShipment xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <Shipment>
        <ShipmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipmentID>
        <FulFillmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </FulFillmentID>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <DeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DeliveryDate>
        <EstDeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </EstDeliveryDate>
        <ShipMethodID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
          <ShipmentDetail>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
        </Details>
        <PackageDetails>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
        </PackageDetails>
      </Shipment>
    </addShipment>
  </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>
    <addShipmentResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addShipmentResult>
        <ShipmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </ShipmentID>
        <FulFillmentID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </FulFillmentID>
        <SOID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SOID>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <DeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DeliveryDate>
        <EstDeliveryDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </EstDeliveryDate>
        <ShipMethodID>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </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>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
          <ShipmentDetail>
            <ShipmentID xsi:nil="true" />
            <SOID xsi:nil="true" />
            <FulFillmentID xsi:nil="true" />
            <SODetailID xsi:nil="true" />
            <SOFulFillDetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
          </ShipmentDetail>
        </Details>
        <PackageDetails>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
          <ShipmentPackageDetail>
            <ShipmentID xsi:nil="true" />
            <ShipmentPackageID xsi:nil="true" />
            <TrackingNumber xsi:nil="true" />
            <DeliveryDate>dateTime</DeliveryDate>
            <Weight xsi:nil="true" />
          </ShipmentPackageDetail>
        </PackageDetails>
      </addShipmentResult>
    </addShipmentResponse>
  </soap12:Body>
</soap12:Envelope>