EwsLabelService Web Service

EwsLabelService

Click here for a complete list of operations.

CreateShipmentNotification

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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: elstestserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/CreateShipmentNotification"

<?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>
    <CreateShipmentNotification xmlns="www.envmgr.com/LabelService">
      <CreateShipmentNotificationRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <TrackingNumber>string</TrackingNumber>
        <Carrier>string</Carrier>
        <WeightOz>double</WeightOz>
        <TrackingType>string</TrackingType>
        <BrandingID>string</BrandingID>
        <NotificationSettingId>string</NotificationSettingId>
        <EmailSenderName>string</EmailSenderName>
        <FromName>string</FromName>
        <FromCompany>string</FromCompany>
        <ReturnAddress1>string</ReturnAddress1>
        <ReturnAddress2>string</ReturnAddress2>
        <ReturnAddress3>string</ReturnAddress3>
        <FromCity>string</FromCity>
        <FromState>string</FromState>
        <FromPostalCode>string</FromPostalCode>
        <FromCountry>string</FromCountry>
        <FromPhone>string</FromPhone>
        <FromEmail>string</FromEmail>
        <ToName>string</ToName>
        <ToCompany>string</ToCompany>
        <ToAddress1>string</ToAddress1>
        <ToAddress2>string</ToAddress2>
        <ToAddress3>string</ToAddress3>
        <ToCity>string</ToCity>
        <ToState>string</ToState>
        <ToPostalCode>string</ToPostalCode>
        <ToCountry>string</ToCountry>
        <ToPhone>string</ToPhone>
        <ToEmail>string</ToEmail>
        <OrderDetails>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <ShippingAndHandlingPrice>decimal</ShippingAndHandlingPrice>
          <TotalDiscountAmount>decimal</TotalDiscountAmount>
          <TotalTaxAmount>decimal</TotalTaxAmount>
          <OrderItems>
            <OrderItem xsi:nil="true" />
            <OrderItem xsi:nil="true" />
          </OrderItems>
          <OrderCurrency>string</OrderCurrency>
        </OrderDetails>
        <ShipDate>dateTime</ShipDate>
        <SendEmail>boolean</SendEmail>
      </CreateShipmentNotificationRequest>
    </CreateShipmentNotification>
  </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>
    <CreateShipmentNotificationResponse xmlns="www.envmgr.com/LabelService">
      <GetShipmentNotificationResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <TrackingUrl>string</TrackingUrl>
      </GetShipmentNotificationResponse>
    </CreateShipmentNotificationResponse>
  </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 /LabelService/EwsLabelService.asmx HTTP/1.1
Host: elstestserver.endicia.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>
    <CreateShipmentNotification xmlns="www.envmgr.com/LabelService">
      <CreateShipmentNotificationRequest>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <TrackingNumber>string</TrackingNumber>
        <Carrier>string</Carrier>
        <WeightOz>double</WeightOz>
        <TrackingType>string</TrackingType>
        <BrandingID>string</BrandingID>
        <NotificationSettingId>string</NotificationSettingId>
        <EmailSenderName>string</EmailSenderName>
        <FromName>string</FromName>
        <FromCompany>string</FromCompany>
        <ReturnAddress1>string</ReturnAddress1>
        <ReturnAddress2>string</ReturnAddress2>
        <ReturnAddress3>string</ReturnAddress3>
        <FromCity>string</FromCity>
        <FromState>string</FromState>
        <FromPostalCode>string</FromPostalCode>
        <FromCountry>string</FromCountry>
        <FromPhone>string</FromPhone>
        <FromEmail>string</FromEmail>
        <ToName>string</ToName>
        <ToCompany>string</ToCompany>
        <ToAddress1>string</ToAddress1>
        <ToAddress2>string</ToAddress2>
        <ToAddress3>string</ToAddress3>
        <ToCity>string</ToCity>
        <ToState>string</ToState>
        <ToPostalCode>string</ToPostalCode>
        <ToCountry>string</ToCountry>
        <ToPhone>string</ToPhone>
        <ToEmail>string</ToEmail>
        <OrderDetails>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <ShippingAndHandlingPrice>decimal</ShippingAndHandlingPrice>
          <TotalDiscountAmount>decimal</TotalDiscountAmount>
          <TotalTaxAmount>decimal</TotalTaxAmount>
          <OrderItems>
            <OrderItem xsi:nil="true" />
            <OrderItem xsi:nil="true" />
          </OrderItems>
          <OrderCurrency>string</OrderCurrency>
        </OrderDetails>
        <ShipDate>dateTime</ShipDate>
        <SendEmail>boolean</SendEmail>
      </CreateShipmentNotificationRequest>
    </CreateShipmentNotification>
  </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>
    <CreateShipmentNotificationResponse xmlns="www.envmgr.com/LabelService">
      <GetShipmentNotificationResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <TrackingUrl>string</TrackingUrl>
      </GetShipmentNotificationResponse>
    </CreateShipmentNotificationResponse>
  </soap12:Body>
</soap12:Envelope>