Shipments Web Service

Shipments

Click here for a complete list of operations.

ShipmentListParm

Get Shipment List - Custom Parameters

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 /WTKServices/Shipments.asmx HTTP/1.1
Host: www.icatconnect.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/ShipmentListParm"

<?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>
    <ShipmentListParm xmlns="http://tempuri.org/">
      <CustomerNo>string</CustomerNo>
      <DateTimeStart>string</DateTimeStart>
      <DateTimeStop>string</DateTimeStop>
      <DateTimeRangeIsDelivery>string</DateTimeRangeIsDelivery>
      <Mode>string</Mode>
      <ServiceLevel>string</ServiceLevel>
      <Status>string</Status>
      <RefNo>string</RefNo>
      <ShipperCity>string</ShipperCity>
      <ConsigneeCity>string</ConsigneeCity>
      <HandlingStation>string</HandlingStation>
      <HAWB>string</HAWB>
    </ShipmentListParm>
  </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>
    <ShipmentListParmResponse xmlns="http://tempuri.org/">
      <ShipmentListParmResult>
        <VendorCosts>
          <VendorCost>
            <ID>string</ID>
            <ServiceCode>string</ServiceCode>
            <EstAmount>decimal</EstAmount>
            <AccessorialCosts xsi:nil="true" />
          </VendorCost>
          <VendorCost>
            <ID>string</ID>
            <ServiceCode>string</ServiceCode>
            <EstAmount>decimal</EstAmount>
            <AccessorialCosts xsi:nil="true" />
          </VendorCost>
        </VendorCosts>
        <CustomerCharges>
          <ChargeCost>
            <Code>string</Code>
            <Amount>decimal</Amount>
          </ChargeCost>
          <ChargeCost>
            <Code>string</Code>
            <Amount>decimal</Amount>
          </ChargeCost>
        </CustomerCharges>
      </ShipmentListParmResult>
    </ShipmentListParmResponse>
  </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 /WTKServices/Shipments.asmx HTTP/1.1
Host: www.icatconnect.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>
    <ShipmentListParm xmlns="http://tempuri.org/">
      <CustomerNo>string</CustomerNo>
      <DateTimeStart>string</DateTimeStart>
      <DateTimeStop>string</DateTimeStop>
      <DateTimeRangeIsDelivery>string</DateTimeRangeIsDelivery>
      <Mode>string</Mode>
      <ServiceLevel>string</ServiceLevel>
      <Status>string</Status>
      <RefNo>string</RefNo>
      <ShipperCity>string</ShipperCity>
      <ConsigneeCity>string</ConsigneeCity>
      <HandlingStation>string</HandlingStation>
      <HAWB>string</HAWB>
    </ShipmentListParm>
  </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>
    <ShipmentListParmResponse xmlns="http://tempuri.org/">
      <ShipmentListParmResult>
        <VendorCosts>
          <VendorCost>
            <ID>string</ID>
            <ServiceCode>string</ServiceCode>
            <EstAmount>decimal</EstAmount>
            <AccessorialCosts xsi:nil="true" />
          </VendorCost>
          <VendorCost>
            <ID>string</ID>
            <ServiceCode>string</ServiceCode>
            <EstAmount>decimal</EstAmount>
            <AccessorialCosts xsi:nil="true" />
          </VendorCost>
        </VendorCosts>
        <CustomerCharges>
          <ChargeCost>
            <Code>string</Code>
            <Amount>decimal</Amount>
          </ChargeCost>
          <ChargeCost>
            <Code>string</Code>
            <Amount>decimal</Amount>
          </ChargeCost>
        </CustomerCharges>
      </ShipmentListParmResult>
    </ShipmentListParmResponse>
  </soap12:Body>
</soap12:Envelope>