PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

setMappedShipMethods

This method removes all of the old ship method mappings to the vendor connector ship via codes and adds the passed parameter as the new set, limiting them to a Vendor Connector Vendor Name if supplied.

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

<?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>
    <setMappedShipMethods xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <shipMethods>
        <VendorMappedShipMethodData>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <VCVendorName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCVendorName>
          <VCShipVia>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCShipVia>
          <VCCarrier>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCCarrier>
        </VendorMappedShipMethodData>
        <VendorMappedShipMethodData>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <VCVendorName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCVendorName>
          <VCShipVia>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCShipVia>
          <VCCarrier>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCCarrier>
        </VendorMappedShipMethodData>
      </shipMethods>
      <optVCVendorName>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optVCVendorName>
    </setMappedShipMethods>
  </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>
    <setMappedShipMethodsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService" />
  </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>
    <setMappedShipMethods xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <shipMethods>
        <VendorMappedShipMethodData>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <VCVendorName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCVendorName>
          <VCShipVia>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCShipVia>
          <VCCarrier>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCCarrier>
        </VendorMappedShipMethodData>
        <VendorMappedShipMethodData>
          <ShipMethod>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </ShipMethod>
          <VCVendorName>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCVendorName>
          <VCShipVia>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCShipVia>
          <VCCarrier>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VCCarrier>
        </VendorMappedShipMethodData>
      </shipMethods>
      <optVCVendorName>
        <Value>string</Value>
        <Valid>boolean</Valid>
      </optVCVendorName>
    </setMappedShipMethods>
  </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>
    <setMappedShipMethodsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService" />
  </soap12:Body>
</soap12:Envelope>