EwsLabelService

Click here for a complete list of operations.

CalculatePostageRate

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: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/CalculatePostageRate"

<?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>
    <CalculatePostageRate xmlns="www.envmgr.com/LabelService">
      <PostageRateRequest ResponseVersion="0 or 1">
        <AutomationRate>string</AutomationRate>
        <Machinable>string</Machinable>
        <ServiceLevel>string</ServiceLevel>
        <SortType>string</SortType>
        <Services DeliveryConfirmation="string" MailClassOnly="string" CertifiedMail="string" COD="string" ElectronicReturnReceipt="string" InsuredMail="string" RegisteredMail="string" RestrictedDelivery="string" ReturnReceipt="string" SignatureConfirmation="string" SignatureService="string" HoldForPickup="string" MerchandiseReturnService="string" OpenAndDistribute="string" AdultSignature="string" AdultSignatureRestrictedDelivery="string" AMDelivery="string" PayOnUse="string" PayOnUseReturn="string" ResidentialDelivery="string" DeliveredDutyPaid="string" InstaLabel="string" NonStandardPackageCharacteristics="string" />
        <Value>float</Value>
        <CODAmount>double</CODAmount>
        <InsuredValue>string</InsuredValue>
        <RegisteredMailValue>double</RegisteredMailValue>
        <EntryFacility>string</EntryFacility>
        <FromPostalCode>string</FromPostalCode>
        <ToPostalCode>string</ToPostalCode>
        <ToCountry>string</ToCountry>
        <ToCountryCode>string</ToCountryCode>
        <ShipDate>string</ShipDate>
        <ShipTime>string</ShipTime>
        <ResponseOptions PostagePrice="string" />
        <OpenAndDistributeFacilityTypeCode>string</OpenAndDistributeFacilityTypeCode>
        <IsConsolidator>string</IsConsolidator>
        <DeliveryTimeDays>string</DeliveryTimeDays>
        <PrintScanBasedPaymentLabel>string</PrintScanBasedPaymentLabel>
        <SpecialContents>string</SpecialContents>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
        <ContentsType>string</ContentsType>
        <NoWeekendDelivery>string</NoWeekendDelivery>
        <Carrier>string</Carrier>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <FromName>string</FromName>
        <FromCompany>string</FromCompany>
        <ReturnAddress1>string</ReturnAddress1>
        <ReturnAddress2>string</ReturnAddress2>
        <ReturnAddress3>string</ReturnAddress3>
        <ReturnAddress4>string</ReturnAddress4>
        <FromCity>string</FromCity>
        <FromState>string</FromState>
        <FromZIP4>string</FromZIP4>
        <FromCountryCode>string</FromCountryCode>
        <FromPhone>string</FromPhone>
        <FromEMail>string</FromEMail>
        <ToName>string</ToName>
        <ToCompany>string</ToCompany>
        <ToAddress1>string</ToAddress1>
        <ToAddress2>string</ToAddress2>
        <ToAddress3>string</ToAddress3>
        <ToAddress4>string</ToAddress4>
        <ToCity>string</ToCity>
        <ToState>string</ToState>
        <ToZIP4>string</ToZIP4>
        <ToDeliveryPoint>string</ToDeliveryPoint>
        <ToPhone>string</ToPhone>
        <ToEMail>string</ToEMail>
      </PostageRateRequest>
    </CalculatePostageRate>
  </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>
    <CalculatePostageRateResponse xmlns="www.envmgr.com/LabelService">
      <PostageRateResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <Zone>string</Zone>
        <Postage>
          <MailService>string</MailService>
          <Rate>decimal</Rate>
        </Postage>
        <Postage>
          <MailService>string</MailService>
          <Rate>decimal</Rate>
        </Postage>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
            <DimWeighting>boolean</DimWeighting>
          </Postage>
          <Fees TotalAmount="decimal">
            <CertificateOfMailing>decimal</CertificateOfMailing>
            <CertifiedMail>decimal</CertifiedMail>
            <CollectOnDelivery>decimal</CollectOnDelivery>
            <DeliveryConfirmation>decimal</DeliveryConfirmation>
            <ElectronicReturnReceipt>decimal</ElectronicReturnReceipt>
            <InsuredMail>decimal</InsuredMail>
            <RegisteredMail>decimal</RegisteredMail>
            <RestrictedDelivery>decimal</RestrictedDelivery>
            <ReturnReceipt>decimal</ReturnReceipt>
            <ReturnReceiptForMerchandise>decimal</ReturnReceiptForMerchandise>
            <SignatureConfirmation>decimal</SignatureConfirmation>
            <SpecialHandling>decimal</SpecialHandling>
            <MerchandiseReturn>decimal</MerchandiseReturn>
            <OpenAndDistribute>decimal</OpenAndDistribute>
            <AdultSignature>decimal</AdultSignature>
            <AdultSignatureRestrictedDelivery>decimal</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>decimal</LiveAnimalSurcharge>
            <FragileHandling>decimal</FragileHandling>
            <AMDelivery>decimal</AMDelivery>
            <GroupedExtraServices xsi:nil="true" />
            <PayOnUse>decimal</PayOnUse>
            <PayOnUseReturn>decimal</PayOnUseReturn>
            <DeliveredDutyPaid>decimal</DeliveredDutyPaid>
            <InstaLabel>decimal</InstaLabel>
            <NonStandardPackageCharacteristics>decimal</NonStandardPackageCharacteristics>
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
          <LabelCategory>string</LabelCategory>
          <Surcharge TotalAmount="decimal">
            <ElevatedRisk>decimal</ElevatedRisk>
            <ExporterValidation>decimal</ExporterValidation>
            <Fuel>decimal</Fuel>
            <OverSized>decimal</OverSized>
            <OverWeight>decimal</OverWeight>
            <RemoteAreaDelivery>decimal</RemoteAreaDelivery>
            <RestrictedDestination>decimal</RestrictedDestination>
            <AdditionalHandling>decimal</AdditionalHandling>
            <NorthernCanada>decimal</NorthernCanada>
            <DeliveryArea>decimal</DeliveryArea>
            <DeliveryAreaExtended>decimal</DeliveryAreaExtended>
            <RemoteAreaExtended>decimal</RemoteAreaExtended>
            <NonStandardLengthDimension1>decimal</NonStandardLengthDimension1>
            <NonStandardLengthDimension2>decimal</NonStandardLengthDimension2>
            <NonStandardVolume>decimal</NonStandardVolume>
          </Surcharge>
        </PostagePrice>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
            <DimWeighting>boolean</DimWeighting>
          </Postage>
          <Fees TotalAmount="decimal">
            <CertificateOfMailing>decimal</CertificateOfMailing>
            <CertifiedMail>decimal</CertifiedMail>
            <CollectOnDelivery>decimal</CollectOnDelivery>
            <DeliveryConfirmation>decimal</DeliveryConfirmation>
            <ElectronicReturnReceipt>decimal</ElectronicReturnReceipt>
            <InsuredMail>decimal</InsuredMail>
            <RegisteredMail>decimal</RegisteredMail>
            <RestrictedDelivery>decimal</RestrictedDelivery>
            <ReturnReceipt>decimal</ReturnReceipt>
            <ReturnReceiptForMerchandise>decimal</ReturnReceiptForMerchandise>
            <SignatureConfirmation>decimal</SignatureConfirmation>
            <SpecialHandling>decimal</SpecialHandling>
            <MerchandiseReturn>decimal</MerchandiseReturn>
            <OpenAndDistribute>decimal</OpenAndDistribute>
            <AdultSignature>decimal</AdultSignature>
            <AdultSignatureRestrictedDelivery>decimal</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>decimal</LiveAnimalSurcharge>
            <FragileHandling>decimal</FragileHandling>
            <AMDelivery>decimal</AMDelivery>
            <GroupedExtraServices xsi:nil="true" />
            <PayOnUse>decimal</PayOnUse>
            <PayOnUseReturn>decimal</PayOnUseReturn>
            <DeliveredDutyPaid>decimal</DeliveredDutyPaid>
            <InstaLabel>decimal</InstaLabel>
            <NonStandardPackageCharacteristics>decimal</NonStandardPackageCharacteristics>
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
          <LabelCategory>string</LabelCategory>
          <Surcharge TotalAmount="decimal">
            <ElevatedRisk>decimal</ElevatedRisk>
            <ExporterValidation>decimal</ExporterValidation>
            <Fuel>decimal</Fuel>
            <OverSized>decimal</OverSized>
            <OverWeight>decimal</OverWeight>
            <RemoteAreaDelivery>decimal</RemoteAreaDelivery>
            <RestrictedDestination>decimal</RestrictedDestination>
            <AdditionalHandling>decimal</AdditionalHandling>
            <NorthernCanada>decimal</NorthernCanada>
            <DeliveryArea>decimal</DeliveryArea>
            <DeliveryAreaExtended>decimal</DeliveryAreaExtended>
            <RemoteAreaExtended>decimal</RemoteAreaExtended>
            <NonStandardLengthDimension1>decimal</NonStandardLengthDimension1>
            <NonStandardLengthDimension2>decimal</NonStandardLengthDimension2>
            <NonStandardVolume>decimal</NonStandardVolume>
          </Surcharge>
        </PostagePrice>
        <PriorityMailExpressCommitments>
          <Commitment>
            <CommitmentName>string</CommitmentName>
            <CommitmentTime>string</CommitmentTime>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Commitment>
          <Commitment>
            <CommitmentName>string</CommitmentName>
            <CommitmentTime>string</CommitmentTime>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Commitment>
        </PriorityMailExpressCommitments>
      </PostageRateResponse>
    </CalculatePostageRateResponse>
  </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: labelserver.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>
    <CalculatePostageRate xmlns="www.envmgr.com/LabelService">
      <PostageRateRequest ResponseVersion="0 or 1">
        <AutomationRate>string</AutomationRate>
        <Machinable>string</Machinable>
        <ServiceLevel>string</ServiceLevel>
        <SortType>string</SortType>
        <Services DeliveryConfirmation="string" MailClassOnly="string" CertifiedMail="string" COD="string" ElectronicReturnReceipt="string" InsuredMail="string" RegisteredMail="string" RestrictedDelivery="string" ReturnReceipt="string" SignatureConfirmation="string" SignatureService="string" HoldForPickup="string" MerchandiseReturnService="string" OpenAndDistribute="string" AdultSignature="string" AdultSignatureRestrictedDelivery="string" AMDelivery="string" PayOnUse="string" PayOnUseReturn="string" ResidentialDelivery="string" DeliveredDutyPaid="string" InstaLabel="string" NonStandardPackageCharacteristics="string" />
        <Value>float</Value>
        <CODAmount>double</CODAmount>
        <InsuredValue>string</InsuredValue>
        <RegisteredMailValue>double</RegisteredMailValue>
        <EntryFacility>string</EntryFacility>
        <FromPostalCode>string</FromPostalCode>
        <ToPostalCode>string</ToPostalCode>
        <ToCountry>string</ToCountry>
        <ToCountryCode>string</ToCountryCode>
        <ShipDate>string</ShipDate>
        <ShipTime>string</ShipTime>
        <ResponseOptions PostagePrice="string" />
        <OpenAndDistributeFacilityTypeCode>string</OpenAndDistributeFacilityTypeCode>
        <IsConsolidator>string</IsConsolidator>
        <DeliveryTimeDays>string</DeliveryTimeDays>
        <PrintScanBasedPaymentLabel>string</PrintScanBasedPaymentLabel>
        <SpecialContents>string</SpecialContents>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
        <ContentsType>string</ContentsType>
        <NoWeekendDelivery>string</NoWeekendDelivery>
        <Carrier>string</Carrier>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <FromName>string</FromName>
        <FromCompany>string</FromCompany>
        <ReturnAddress1>string</ReturnAddress1>
        <ReturnAddress2>string</ReturnAddress2>
        <ReturnAddress3>string</ReturnAddress3>
        <ReturnAddress4>string</ReturnAddress4>
        <FromCity>string</FromCity>
        <FromState>string</FromState>
        <FromZIP4>string</FromZIP4>
        <FromCountryCode>string</FromCountryCode>
        <FromPhone>string</FromPhone>
        <FromEMail>string</FromEMail>
        <ToName>string</ToName>
        <ToCompany>string</ToCompany>
        <ToAddress1>string</ToAddress1>
        <ToAddress2>string</ToAddress2>
        <ToAddress3>string</ToAddress3>
        <ToAddress4>string</ToAddress4>
        <ToCity>string</ToCity>
        <ToState>string</ToState>
        <ToZIP4>string</ToZIP4>
        <ToDeliveryPoint>string</ToDeliveryPoint>
        <ToPhone>string</ToPhone>
        <ToEMail>string</ToEMail>
      </PostageRateRequest>
    </CalculatePostageRate>
  </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>
    <CalculatePostageRateResponse xmlns="www.envmgr.com/LabelService">
      <PostageRateResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <Zone>string</Zone>
        <Postage>
          <MailService>string</MailService>
          <Rate>decimal</Rate>
        </Postage>
        <Postage>
          <MailService>string</MailService>
          <Rate>decimal</Rate>
        </Postage>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
            <DimWeighting>boolean</DimWeighting>
          </Postage>
          <Fees TotalAmount="decimal">
            <CertificateOfMailing>decimal</CertificateOfMailing>
            <CertifiedMail>decimal</CertifiedMail>
            <CollectOnDelivery>decimal</CollectOnDelivery>
            <DeliveryConfirmation>decimal</DeliveryConfirmation>
            <ElectronicReturnReceipt>decimal</ElectronicReturnReceipt>
            <InsuredMail>decimal</InsuredMail>
            <RegisteredMail>decimal</RegisteredMail>
            <RestrictedDelivery>decimal</RestrictedDelivery>
            <ReturnReceipt>decimal</ReturnReceipt>
            <ReturnReceiptForMerchandise>decimal</ReturnReceiptForMerchandise>
            <SignatureConfirmation>decimal</SignatureConfirmation>
            <SpecialHandling>decimal</SpecialHandling>
            <MerchandiseReturn>decimal</MerchandiseReturn>
            <OpenAndDistribute>decimal</OpenAndDistribute>
            <AdultSignature>decimal</AdultSignature>
            <AdultSignatureRestrictedDelivery>decimal</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>decimal</LiveAnimalSurcharge>
            <FragileHandling>decimal</FragileHandling>
            <AMDelivery>decimal</AMDelivery>
            <GroupedExtraServices xsi:nil="true" />
            <PayOnUse>decimal</PayOnUse>
            <PayOnUseReturn>decimal</PayOnUseReturn>
            <DeliveredDutyPaid>decimal</DeliveredDutyPaid>
            <InstaLabel>decimal</InstaLabel>
            <NonStandardPackageCharacteristics>decimal</NonStandardPackageCharacteristics>
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
          <LabelCategory>string</LabelCategory>
          <Surcharge TotalAmount="decimal">
            <ElevatedRisk>decimal</ElevatedRisk>
            <ExporterValidation>decimal</ExporterValidation>
            <Fuel>decimal</Fuel>
            <OverSized>decimal</OverSized>
            <OverWeight>decimal</OverWeight>
            <RemoteAreaDelivery>decimal</RemoteAreaDelivery>
            <RestrictedDestination>decimal</RestrictedDestination>
            <AdditionalHandling>decimal</AdditionalHandling>
            <NorthernCanada>decimal</NorthernCanada>
            <DeliveryArea>decimal</DeliveryArea>
            <DeliveryAreaExtended>decimal</DeliveryAreaExtended>
            <RemoteAreaExtended>decimal</RemoteAreaExtended>
            <NonStandardLengthDimension1>decimal</NonStandardLengthDimension1>
            <NonStandardLengthDimension2>decimal</NonStandardLengthDimension2>
            <NonStandardVolume>decimal</NonStandardVolume>
          </Surcharge>
        </PostagePrice>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
            <DimWeighting>boolean</DimWeighting>
          </Postage>
          <Fees TotalAmount="decimal">
            <CertificateOfMailing>decimal</CertificateOfMailing>
            <CertifiedMail>decimal</CertifiedMail>
            <CollectOnDelivery>decimal</CollectOnDelivery>
            <DeliveryConfirmation>decimal</DeliveryConfirmation>
            <ElectronicReturnReceipt>decimal</ElectronicReturnReceipt>
            <InsuredMail>decimal</InsuredMail>
            <RegisteredMail>decimal</RegisteredMail>
            <RestrictedDelivery>decimal</RestrictedDelivery>
            <ReturnReceipt>decimal</ReturnReceipt>
            <ReturnReceiptForMerchandise>decimal</ReturnReceiptForMerchandise>
            <SignatureConfirmation>decimal</SignatureConfirmation>
            <SpecialHandling>decimal</SpecialHandling>
            <MerchandiseReturn>decimal</MerchandiseReturn>
            <OpenAndDistribute>decimal</OpenAndDistribute>
            <AdultSignature>decimal</AdultSignature>
            <AdultSignatureRestrictedDelivery>decimal</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>decimal</LiveAnimalSurcharge>
            <FragileHandling>decimal</FragileHandling>
            <AMDelivery>decimal</AMDelivery>
            <GroupedExtraServices xsi:nil="true" />
            <PayOnUse>decimal</PayOnUse>
            <PayOnUseReturn>decimal</PayOnUseReturn>
            <DeliveredDutyPaid>decimal</DeliveredDutyPaid>
            <InstaLabel>decimal</InstaLabel>
            <NonStandardPackageCharacteristics>decimal</NonStandardPackageCharacteristics>
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
          <LabelCategory>string</LabelCategory>
          <Surcharge TotalAmount="decimal">
            <ElevatedRisk>decimal</ElevatedRisk>
            <ExporterValidation>decimal</ExporterValidation>
            <Fuel>decimal</Fuel>
            <OverSized>decimal</OverSized>
            <OverWeight>decimal</OverWeight>
            <RemoteAreaDelivery>decimal</RemoteAreaDelivery>
            <RestrictedDestination>decimal</RestrictedDestination>
            <AdditionalHandling>decimal</AdditionalHandling>
            <NorthernCanada>decimal</NorthernCanada>
            <DeliveryArea>decimal</DeliveryArea>
            <DeliveryAreaExtended>decimal</DeliveryAreaExtended>
            <RemoteAreaExtended>decimal</RemoteAreaExtended>
            <NonStandardLengthDimension1>decimal</NonStandardLengthDimension1>
            <NonStandardLengthDimension2>decimal</NonStandardLengthDimension2>
            <NonStandardVolume>decimal</NonStandardVolume>
          </Surcharge>
        </PostagePrice>
        <PriorityMailExpressCommitments>
          <Commitment>
            <CommitmentName>string</CommitmentName>
            <CommitmentTime>string</CommitmentTime>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Commitment>
          <Commitment>
            <CommitmentName>string</CommitmentName>
            <CommitmentTime>string</CommitmentTime>
            <Location xsi:nil="true" />
            <Location xsi:nil="true" />
          </Commitment>
        </PriorityMailExpressCommitments>
      </PostageRateResponse>
    </CalculatePostageRateResponse>
  </soap12:Body>
</soap12:Envelope>