ShipAdvisorWS Web Service

ShipAdvisorWS

Click here for a complete list of operations.

GetShipmentByOrder

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 /Main.asmx HTTP/1.1
Host: shipadvisor.edisoftws.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.consignorsupport.no/ShipAdvisor/GetShipmentByOrder"

<?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:Header>
    <ServiceAuthenticationHeader xmlns="SoapAuthenticator">
      <Username>string</Username>
      <Password>string</Password>
      <IsEncrypted>boolean</IsEncrypted>
    </ServiceAuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <GetShipmentByOrder xmlns="http://ws.consignorsupport.no/ShipAdvisor">
      <orderNumber>string</orderNumber>
      <installationID>string</installationID>
      <actorID>int</actorID>
    </GetShipmentByOrder>
  </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>
    <GetShipmentByOrderResponse xmlns="http://ws.consignorsupport.no/ShipAdvisor">
      <GetShipmentByOrderResult>
        <ResponseStatus>Success or Failure</ResponseStatus>
        <ErrorMessages>
          <string>string</string>
          <string>string</string>
        </ErrorMessages>
        <Shipments>
          <PortalShipment>
            <Shipment xsi:nil="true" />
            <WebShop xsi:nil="true" />
            <Product xsi:nil="true" />
          </PortalShipment>
          <PortalShipment>
            <Shipment xsi:nil="true" />
            <WebShop xsi:nil="true" />
            <Product xsi:nil="true" />
          </PortalShipment>
        </Shipments>
      </GetShipmentByOrderResult>
    </GetShipmentByOrderResponse>
  </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 /Main.asmx HTTP/1.1
Host: shipadvisor.edisoftws.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:Header>
    <ServiceAuthenticationHeader xmlns="SoapAuthenticator">
      <Username>string</Username>
      <Password>string</Password>
      <IsEncrypted>boolean</IsEncrypted>
    </ServiceAuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <GetShipmentByOrder xmlns="http://ws.consignorsupport.no/ShipAdvisor">
      <orderNumber>string</orderNumber>
      <installationID>string</installationID>
      <actorID>int</actorID>
    </GetShipmentByOrder>
  </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>
    <GetShipmentByOrderResponse xmlns="http://ws.consignorsupport.no/ShipAdvisor">
      <GetShipmentByOrderResult>
        <ResponseStatus>Success or Failure</ResponseStatus>
        <ErrorMessages>
          <string>string</string>
          <string>string</string>
        </ErrorMessages>
        <Shipments>
          <PortalShipment>
            <Shipment xsi:nil="true" />
            <WebShop xsi:nil="true" />
            <Product xsi:nil="true" />
          </PortalShipment>
          <PortalShipment>
            <Shipment xsi:nil="true" />
            <WebShop xsi:nil="true" />
            <Product xsi:nil="true" />
          </PortalShipment>
        </Shipments>
      </GetShipmentByOrderResult>
    </GetShipmentByOrderResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Main.asmx/GetShipmentByOrder?orderNumber=string&installationID=string&actorID=string HTTP/1.1
Host: shipadvisor.edisoftws.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetShipmentByOrderOutput xmlns="http://ws.consignorsupport.no/ShipAdvisor">
  <ResponseStatus>Success or Failure</ResponseStatus>
  <ErrorMessages>
    <string>string</string>
    <string>string</string>
  </ErrorMessages>
  <Shipments>
    <PortalShipment>
      <Shipment>
        <WebShopId>int</WebShopId>
        <OrderNumber>string</OrderNumber>
        <ChODId>long</ChODId>
        <InsuranceAmount>double</InsuranceAmount>
        <CODAmount>double</CODAmount>
        <Lines d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyCode>string</CurrencyCode>
        <ExchangeRate>double</ExchangeRate>
        <Shopper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Sender d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RequestDate>dateTime</RequestDate>
        <TotalOrderAmount>double</TotalOrderAmount>
        <ShipLoadmeterMM>unsignedLong</ShipLoadmeterMM>
        <DeliveryDate>dateTime</DeliveryDate>
        <Keywords>string</Keywords>
        <InvoiceAmount>double</InvoiceAmount>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <PickupStartDatetime>dateTime</PickupStartDatetime>
      </Shipment>
      <WebShop>
        <InstallationId>string</InstallationId>
        <ActorId>int</ActorId>
        <Name>string</Name>
        <Address>string</Address>
        <Address2>string</Address2>
        <PostCode>string</PostCode>
        <CountryCode>string</CountryCode>
        <Country>string</Country>
        <City>string</City>
        <State>string</State>
      </WebShop>
      <Product>
        <WebShopProductId>long</WebShopProductId>
        <ConceptId>int</ConceptId>
        <CustomProductDBId>int</CustomProductDBId>
        <ServiceIds d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Price>double</Price>
        <CurrencyCode>string</CurrencyCode>
        <DropPoint d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Product>
    </PortalShipment>
    <PortalShipment>
      <Shipment>
        <WebShopId>int</WebShopId>
        <OrderNumber>string</OrderNumber>
        <ChODId>long</ChODId>
        <InsuranceAmount>double</InsuranceAmount>
        <CODAmount>double</CODAmount>
        <Lines d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CurrencyCode>string</CurrencyCode>
        <ExchangeRate>double</ExchangeRate>
        <Shopper d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Sender d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RequestDate>dateTime</RequestDate>
        <TotalOrderAmount>double</TotalOrderAmount>
        <ShipLoadmeterMM>unsignedLong</ShipLoadmeterMM>
        <DeliveryDate>dateTime</DeliveryDate>
        <Keywords>string</Keywords>
        <InvoiceAmount>double</InvoiceAmount>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <PickupStartDatetime>dateTime</PickupStartDatetime>
      </Shipment>
      <WebShop>
        <InstallationId>string</InstallationId>
        <ActorId>int</ActorId>
        <Name>string</Name>
        <Address>string</Address>
        <Address2>string</Address2>
        <PostCode>string</PostCode>
        <CountryCode>string</CountryCode>
        <Country>string</Country>
        <City>string</City>
        <State>string</State>
      </WebShop>
      <Product>
        <WebShopProductId>long</WebShopProductId>
        <ConceptId>int</ConceptId>
        <CustomProductDBId>int</CustomProductDBId>
        <ServiceIds d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Price>double</Price>
        <CurrencyCode>string</CurrencyCode>
        <DropPoint d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Product>
    </PortalShipment>
  </Shipments>
</GetShipmentByOrderOutput>