Navbar

Endicia ELS API

Overview

About the Endicia API

ELS is primarily used for rating and printing USPS shipping and mailing labels. As a focused, single-carrier provider, this API offers the most robust Postal solution available with unmatched performance and reliability.

This API is SOAP-based; if you would rather develop to a USPS-focused REST API, please contact us.

Changes in ELS 8.8

Description of Change Calls Impacted Mandatory
Added ContentsType for international services.
Required for FirstClassMailInternational
CalculatePostageRate
CalculatePostageRates
Yes

For previous version, see Version 8.7

Major Features

Below is a quick look at the major features supported by the Endicia API. For details on these features, click on the links below.

Support

If you get stuck, need help, or just want to chat about the world of online postage, we’re here for you. Real people who know the API inside and out are ready to help get you up and running.

Contact us M-F, 6AM to 6PM. For high-volume accounts, we offer 24/7 support.

Getting Started

Sign Up

To make your first call, you’ll need credentials.

Click here to sign up for a free Endicia account that can be used to make calls in our sandbox environment.

To make production calls (required to print live postage) you’ll need a paid, production account.

Authentication

The header for each call must include a valid credential set. Credential sets consist of the following:

WSDL

The WSDL for the Endicia SOAP API Sandbox is available here: https://elstestserver.endicia.com/LabelService/EwsLabelService.asmx?wsdl

Staging/Production

While these methods are the same in staging and production, contact us to access production. Your sales representative can provide you with a unique URL containing your RequesterID (Partner ID).

What else?

As you get more familiar with the API, you’ll probably have some questions, like or “What mailpiece shapes are compatible with which mail classes?” or “What does this error mean?”. This stuff is covered in the appendix. If you have any questions, don’t hesitate to ask by contacting our support.

Quick Start Guide

To make calls, you’ll need a free Endicia account and a RequestorID. Once you’ve got that, use the XML requests below to request your first Shipping Label. You’ll need to enter your credentials; feel free to edit the from and to address, or some of the other highlighted values.

ELS Sandbox Account

The ELS Sandbox allows you to build your integration in a safe environment using unlimited “play money”. You will not be charged for service or transaction fees for accounts created in the ELS Sandbox, and you can create as many accounts as you need for testing. These labels cannot be used to mail or ship.

If you run into any problems along the way, you may contact Endicia’s Label Server technical support at labelserver@endicia.com. Include your sandbox account number, if you know it, and as much detail as possible to assist us in helping you. The fastest way for us to be able to help is by sending us a copy of the call and response you get from the API.

Authentication

You'll need credentials to authenticate. The primary means of authentication is through the use of an account passphrase. For partners who work with a number of accounts that are owned by their customers, we support a number of cryptographic token-based account credentials.

Please contact labelserver@endicia.com for more details on these methods and to discuss requirements.

Buy Postage

Sample BuyPostage Request

<BuyPostage>
  <RecreditRequest>
    <RequesterID>lxxx</RequesterID>
    <RequestID>1</RequestID>
    <CertifiedIntermediary>
      <AccountID>9999999</AccountID>
      <PassPhrase>ABCDEFGHIJK</PassPhrase>
    </CertifiedIntermediary>
    <RecreditAmount>500</RecreditAmount>
  </RecreditRequest>
</BuyPostage>

Sample BuyPostage Response

<BuyPostageResponse xmlns="www.envmgr.com/LabelService">
   <RecreditRequestResponse>
      <Status>0</Status>
      <RequesterID>lxxx</RequesterID>
      <RequestID>1</RequestID>
      <CertifiedIntermediary>
         <AccountID>9999999</AccountID>
         <SerialNumber>X</SerialNumber>
         <PostageBalance>500</PostageBalance>
         <AscendingBalance>500</AscendingBalance>
         <AccountStatus>A</AccountStatus>
         <DeviceID>00000000000</DeviceID>
      </CertifiedIntermediary>
      <TransactionID>0987654321</TransactionID>
      <ControlRegister>500</ControlRegister>
   </RecreditRequestResponse>
</BuyPostageResponse>

After activating your account, you will need to add funds to your Sandbox account for testing. You can initially purchase up to $500 in postage and have a maximum balance of $500 in your account at any given time. As long as you buy postage on the ELS test server, the postage will not be live and not cost you anything.

  1. Point your request to the sandbox server.
  2. Run the sample BuyPostage API method on the right. For full details of the call, see BuyPostage in the API Reference below.
  3. Description of the elements:
    • RequesterID and CertifiedIntermediary are both required, specifying who is making the request.
    • The RecreditAmount is where you will enter the amount of postage you are purchasing.
  4. Once you’ve executed the RecreditRequest API method successfully, your account will be funded and ready to view shipping rates and print labels

View Shipping Rates

The following API options for calculating postage and fees in Endicia Label Server (ELS) are:

The following table summarizes how you determine which option to use.

Option Type CalculatePostageRate CalculatePostageRates
Price for a known mail class of service Y N
Return mail class options with price N Y
Can return a retail price Y* N**

* Choose <pricing> to return requested rate.
** Returns pricing level associated with the customer account number, except for Library Mail, Media Mail, and Retail Ground, which are always retail.

When using either of these API's, remember that you must explicitly specify each service that you are requesting or that service will not be included in the <TotalAmount> element or the <Fees> node of the response. For example, if you do not include a tracking method (DeliveryConfirmation, CertifiedMail, or SignatureConfirmation) in a GetPostageLabel request, DeliveryConfirmation will be selected as the default tracking method, and the associated fee will be included in the Postage and Fees for that label. However, if you do not include a tracking method in a CalculatePostageRate or CalculatePostageRates request, ELS will not include it in the response.

Use the ResponseVersion attribute in the request to specify whether you prefer basic Services validation, or validation that you would receive in a Label Request. The Label Request validates the Services you have selected with the MailClass and other request parameters to ensure that there is a valid Service Type Code (STC) for that combination of services. We recommend STC validation to guarantee accurate services and rates.

View a Single Rate

Sample single rate through CalculatePostageRate Request

<PostageRateRequest>
  <RequesterID>lxxx</RequesterID>
  <CertifiedIntermediary>
    <AccountID>9999999</AccountID>
    <PassPhrase>ABCDEFGHIJK</PassPhrase>
  </CertifiedIntermediary>
  <MailClass>Priority</MailClass>
  <WeightOz>32</WeightOz>
  <MailpieceShape>Parcel</MailpieceShape>
  <FromPostalCode>90245</FromPostalCode>
  <ToPostalCode>90247</ToPostalCode>
</PostageRateRequest>

Sample single rate through CalculatePostageRate response

<PostageRateResponse>
   <Status>0</Status>
   <Zone>1</Zone>
   <Postage>
      <MailService>Priority Mail</MailService>
      <Rate>6.52</Rate>
   </Postage>
</PostageRateResponse>
  1. Point your request to the sandbox server.
  2. Run the sample CalculatePostageRate API Method on the right. For full details of the call, see CalculatePostageRate in the API Reference below.
  3. Description of the elements:
    • RequesterID and CertifiedIntermediary are both required, specifying who is making the request.
    • MailClass, WeightOz, FromPostalCode, ToPostalCode, and ToCountryCode (if mailing internationally) are also all required, and contain the basic building blocks of the package being shipped.
    • Note that MailClass is a specific mailclass
  4. Since you have now funds and a rate, you're now ready to print postage labels using the GetPostageLabel API method.

Rate Shopping

Sample multi-rate through CalculatePostageRate request

<PostageRatesRequest>
  <RequesterID>lxxx</RequesterID>
  <CertifiedIntermediary>
    <AccountID>9999999</AccountID>
    <PassPhrase>ABCDEFGHIJK</PassPhrase>
  </CertifiedIntermediary>
  <MailClass>Domestic</MailClass>
  <WeightOz>32</WeightOz>
  <MailpieceShape>Parcel</MailpieceShape>
  <FromPostalCode>90245</FromPostalCode>
  <ToPostalCode>90247</ToPostalCode>
</PostageRatesRequest>

Sample multi-rate through CalculatePostageRate response

<PostageRatesResponse>
      <Status>0</Status>
      <PostagePrice TotalAmount="6.52">
         <MailClass>Priority</MailClass>
         <Postage TotalAmount="6.52">
            <MailService>Priority Mail</MailService>
            <Zone>1</Zone>
            <IntraBMC>true</IntraBMC>
            <Pricing>CommercialBase</Pricing>
         </Postage>
         <Fees TotalAmount="0">
            <CertificateOfMailing>0</CertificateOfMailing>
            <CertifiedMail>0</CertifiedMail>
            <CollectOnDelivery>0</CollectOnDelivery>
            <DeliveryConfirmation>0</DeliveryConfirmation>
            <ElectronicReturnReceipt>0</ElectronicReturnReceipt>
            <InsuredMail>0</InsuredMail>
            <RegisteredMail>0</RegisteredMail>
            <RestrictedDelivery>0</RestrictedDelivery>
            <ReturnReceipt>0</ReturnReceipt>
            <ReturnReceiptForMerchandise>0</ReturnReceiptForMerchandise>
            <SignatureConfirmation>0</SignatureConfirmation>
            <SpecialHandling>0</SpecialHandling>
            <MerchandiseReturn>0</MerchandiseReturn>
            <OpenAndDistribute>0</OpenAndDistribute>
            <AdultSignature>0</AdultSignature>
            <AdultSignatureRestrictedDelivery>0</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>0</LiveAnimalSurcharge>
            <FragileHandling>0</FragileHandling>
            <AMDelivery>0</AMDelivery>
            <GroupedExtraServices Services="">
               <FeeAmount>0</FeeAmount>
            </GroupedExtraServices>
         </Fees>
         <DdpRate>0</DdpRate>
      </PostagePrice>
      <PostagePrice TotalAmount="21.18">
         <MailClass>PriorityExpress</MailClass>
         <Postage TotalAmount="21.18">
            <MailService>Priority Mail Express</MailService>
            <Zone>1</Zone>
            <IntraBMC>true</IntraBMC>
            <Pricing>CommercialBase</Pricing>
         </Postage>
         <Fees TotalAmount="0">
            <CertificateOfMailing>0</CertificateOfMailing>
            <CertifiedMail>0</CertifiedMail>
            <CollectOnDelivery>0</CollectOnDelivery>
            <DeliveryConfirmation>0</DeliveryConfirmation>
            <ElectronicReturnReceipt>0</ElectronicReturnReceipt>
            <InsuredMail>0</InsuredMail>
            <RegisteredMail>0</RegisteredMail>
            <RestrictedDelivery>0</RestrictedDelivery>
            <ReturnReceipt>0</ReturnReceipt>
            <ReturnReceiptForMerchandise>0</ReturnReceiptForMerchandise>
            <SignatureConfirmation>0</SignatureConfirmation>
            <SpecialHandling>0</SpecialHandling>
            <MerchandiseReturn>0</MerchandiseReturn>
            <OpenAndDistribute>0</OpenAndDistribute>
            <AdultSignature>0</AdultSignature>
            <AdultSignatureRestrictedDelivery>0</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>0</LiveAnimalSurcharge>
            <FragileHandling>0</FragileHandling>
            <AMDelivery>0</AMDelivery>
            <GroupedExtraServices Services="">
               <FeeAmount>0</FeeAmount>
            </GroupedExtraServices>
         </Fees>
         <DdpRate>0</DdpRate>
      </PostagePrice>
      <PostagePrice TotalAmount="2.97">
         <MailClass>LibraryMail</MailClass>
         <Postage TotalAmount="2.97">
            <MailService>Library Mail</MailService>
            <Zone>1</Zone>
            <IntraBMC>true</IntraBMC>
            <Pricing>Retail</Pricing>
         </Postage>
         <Fees TotalAmount="0">
            <CertificateOfMailing>0</CertificateOfMailing>
            <CertifiedMail>0</CertifiedMail>
            <CollectOnDelivery>0</CollectOnDelivery>
            <DeliveryConfirmation>0</DeliveryConfirmation>
            <ElectronicReturnReceipt>0</ElectronicReturnReceipt>
            <InsuredMail>0</InsuredMail>
            <RegisteredMail>0</RegisteredMail>
            <RestrictedDelivery>0</RestrictedDelivery>
            <ReturnReceipt>0</ReturnReceipt>
            <ReturnReceiptForMerchandise>0</ReturnReceiptForMerchandise>
            <SignatureConfirmation>0</SignatureConfirmation>
            <SpecialHandling>0</SpecialHandling>
            <MerchandiseReturn>0</MerchandiseReturn>
            <OpenAndDistribute>0</OpenAndDistribute>
            <AdultSignature>0</AdultSignature>
            <AdultSignatureRestrictedDelivery>0</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>0</LiveAnimalSurcharge>
            <FragileHandling>0</FragileHandling>
            <AMDelivery>0</AMDelivery>
            <GroupedExtraServices Services="">
               <FeeAmount>0</FeeAmount>
            </GroupedExtraServices>
         </Fees>
         <DdpRate>0</DdpRate>
      </PostagePrice>
      <PostagePrice TotalAmount="3.12">
         <MailClass>MediaMail</MailClass>
         <Postage TotalAmount="3.12">
            <MailService>Media Mail</MailService>
            <Zone>1</Zone>
            <IntraBMC>true</IntraBMC>
            <Pricing>Retail</Pricing>
         </Postage>
         <Fees TotalAmount="0">
            <CertificateOfMailing>0</CertificateOfMailing>
            <CertifiedMail>0</CertifiedMail>
            <CollectOnDelivery>0</CollectOnDelivery>
            <DeliveryConfirmation>0</DeliveryConfirmation>
            <ElectronicReturnReceipt>0</ElectronicReturnReceipt>
            <InsuredMail>0</InsuredMail>
            <RegisteredMail>0</RegisteredMail>
            <RestrictedDelivery>0</RestrictedDelivery>
            <ReturnReceipt>0</ReturnReceipt>
            <ReturnReceiptForMerchandise>0</ReturnReceiptForMerchandise>
            <SignatureConfirmation>0</SignatureConfirmation>
            <SpecialHandling>0</SpecialHandling>
            <MerchandiseReturn>0</MerchandiseReturn>
            <OpenAndDistribute>0</OpenAndDistribute>
            <AdultSignature>0</AdultSignature>
            <AdultSignatureRestrictedDelivery>0</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>0</LiveAnimalSurcharge>
            <FragileHandling>0</FragileHandling>
            <AMDelivery>0</AMDelivery>
            <GroupedExtraServices Services="">
               <FeeAmount>0</FeeAmount>
            </GroupedExtraServices>
         </Fees>
         <DdpRate>0</DdpRate>
      </PostagePrice>
      <PostagePrice TotalAmount="6.52">
         <MailClass>ParcelSelect</MailClass>
         <Postage TotalAmount="6.52">
            <MailService>Parcel Select Ground</MailService>
            <Zone>1</Zone>
            <IntraBMC>true</IntraBMC>
            <Pricing>Commercial</Pricing>
         </Postage>
         <Fees TotalAmount="0">
            <CertificateOfMailing>0</CertificateOfMailing>
            <CertifiedMail>0</CertifiedMail>
            <CollectOnDelivery>0</CollectOnDelivery>
            <DeliveryConfirmation>0</DeliveryConfirmation>
            <ElectronicReturnReceipt>0</ElectronicReturnReceipt>
            <InsuredMail>0</InsuredMail>
            <RegisteredMail>0</RegisteredMail>
            <RestrictedDelivery>0</RestrictedDelivery>
            <ReturnReceipt>0</ReturnReceipt>
            <ReturnReceiptForMerchandise>0</ReturnReceiptForMerchandise>
            <SignatureConfirmation>0</SignatureConfirmation>
            <SpecialHandling>0</SpecialHandling>
            <MerchandiseReturn>0</MerchandiseReturn>
            <OpenAndDistribute>0</OpenAndDistribute>
            <AdultSignature>0</AdultSignature>
            <AdultSignatureRestrictedDelivery>0</AdultSignatureRestrictedDelivery>
            <LiveAnimalSurcharge>0</LiveAnimalSurcharge>
            <FragileHandling>0</FragileHandling>
            <AMDelivery>0</AMDelivery>
            <GroupedExtraServices Services="">
               <FeeAmount>0</FeeAmount>
            </GroupedExtraServices>
         </Fees>
         <DdpRate>0</DdpRate>
      </PostagePrice>
   </PostageRatesResponse>

  1. Point your request to the sandbox server.
  2. Run the CalculatePostageRates API Method on the right. For full details of the call, see CalculatePostageRates in the API Reference below.
  3. Description of the elements:
    • RequesterID and CertifiedIntermediary are both required, specifying who is making the request.
    • WeightOz, FromPostalCode, ToPostalCode, and ToCountryCode (if mailing internationally) are also all required, and contain the basic building blocks of the package being shipped.
    • Note that MailClass is not the literal mailclass.
  4. Since you’ve executed the RecreditRequest API method successfully, your account is be funded and ready to print postage labels using the GetPostageLabel API method.

Create Label

There are dozens of options and combinations available to support the many USPS offerings for domestic, international and consolidator label printing. So we’re going to start off with a Label Request in its simplest form, using only the required and most common request settings.

Create Domestic Label

Sample Domestic GetPostageLabel Request

<LabelRequest>
  <MailClass>Priority</MailClass>
  <WeightOz>16</WeightOz>
  <RequesterID>lxxx</RequesterID>
  <AccountID>9999999</AccountID>
  <PassPhrase>ABCDEFGHIJK</PassPhrase>
  <PartnerCustomerID>100</PartnerCustomerID>
  <PartnerTransactionID>200</PartnerTransactionID>
  <ToName>Jane Doe</ToName>
  <ToAddress1>278 Castro Street</ToAddress1>
  <ToCity>Mountain View</ToCity>
  <ToState>CA</ToState>
  <ToPostalCode>94041</ToPostalCode>
  <FromCompany>Endicia, Inc.</FromCompany>
  <FromName>John Doe</FromName>
  <ReturnAddress1>1990 Grand Ave</ReturnAddress1>
  <FromCity>El Segundo</FromCity>
  <FromState>CA</FromState>
  <FromPostalCode>90245</FromPostalCode>
</LabelRequest>

Sample Domestic GetPostageLabel Response

<GetPostageLabelResponse xmlns="www.envmgr.com/LabelService">
   <LabelRequestResponse>
      <Status>0</Status>
      <Base64LabelImage>iVBORw0KGgoAAAANSUhEUgAABLAAAAcICAIA...</Base64LabelImage>
      <PIC>0405510200881102197293</PIC>
      <TrackingNumber>0405510200881102197293</TrackingNumber>
      <FinalPostage>6.56</FinalPostage>
      <TransactionID>9</TransactionID>
      <TransactionDateTime>20171110195015</TransactionDateTime>
      <PostmarkDate>20171110</PostmarkDate>
      <PostageBalance>237.86</PostageBalance>
      <CostCenter>0</CostCenter>
      <RequesterID>lxxx</RequesterID>
      <ReferenceID2/>
      <ReferenceID3/>
      <ReferenceID4/>
      <SDRValue/>
   </LabelRequestResponse>
</GetPostageLabelResponse>

  1. Point your request to the sandbox server.
  2. Run the GetPostageLabel API method on the right. For full details of the call, see GetPostageLabel in the API Reference below.
  3. First, notice that the <AccountID>and <PassPhrase> are not enclosed in a <CertifiedIntermediary> node, as the other requests are.
  4. Description of the elements:
    • RequesterID is required to specify who is making the request.
    • <PartnerCustomerID> and <PartnerTransactionID> are required elements, but are not validated under normal circumstances. Neither of these values are stored in our database nor returned in the Label Response XML. You can use the <PartnerCustomerID> to identify your customer’s requests using your account, and the <PartnerTransactionID> to uniquely identify your customer’s transaction, if you would like. Otherwise, you can simply set a default value for them, as we have in the example.
    • <ToName>, <ToAddress1>, <ToCity>, <ToState> and <ToPostalCode> contain the basic address elements of the addressee.
    • <FromCompany>, <FromName>, <ReturnAddress1>, <FromCity>, <FromState>, <FromPostalCode> contain the basic return address elements of the sender.
  5. When you execute the above request using your credentials, you’ll receive a response back containing a <Base64> element, which will require decoding before the label can be printed. The default image format is PNG, but as you’ll see later, there are several other options you can choose.

Best Practices

"To" and "From" Address Elements: Due to minimum font size requirements and available space on various label formats, not all To and From address elements are available for every Label Type. Count each of the following as an individual line:

Key points:

<ToAddress1>123 Main St Apt 110</ToAddress1>

You can also use ToAddress1 and ToAddress2:

<ToAddress1>123 Main St</ToAddress1>
<ToAddress2>Apt 110</ToAddress2>

It is recommended that you do not use ToAddress3 or ToAddress4 for domestic addresses. Your address may not validate properly, and the USPS may not be able to deliver it.

For best results, the street address and secondary address (Suite, Unit, Apt) should be placed together in the <ToAddress1> element, or the street address into <ToAddress1> and the secondary address into <ToAddress2>. Ensure that the city, state and ZIP Code are all in <ToAddress3>. A comma to separate the <ToCity> and <ToState> is not required.

Create International Label

Sample International GetPostageLabel Request

<GetPostageLabel>
   <LabelRequest LabelType="International"
                 LabelSubtype="Integrated"
                 LabelSize="4x6"
                 ImageFormat="png">
      <MailClass>PriorityMailInternational</MailClass>
      <WeightOz>12</WeightOz>
      <DateAdvance>1</DateAdvance>
      <MailpieceDimensions>
         <Length>8</Length>
         <Width>6</Width>
         <Height>2</Height>
      </MailpieceDimensions>
      <RequesterID>lxxx</RequesterID>
     <AccountID>9999999</AccountID>
      <PassPhrase>ABCDEFGHIJK</PassPhrase>
      <PartnerTransactionID>1234567890</PartnerTransactionID>
      <CustomsInfo>
         <ContentsType>Documents</ContentsType>
         <CustomsItems>
            <CustomsItem>
               <Description>Contract</Description>
               <Quantity>1</Quantity>
               <Weight>12</Weight>
               <Value>15</Value>
            </CustomsItem>
         </CustomsItems>
      </CustomsInfo>
      <FromCompany>Endicia.com</FromCompany>
      <ReturnAddress1>1990 E Grand Ave</ReturnAddress1>
      <FromCity>El Segundo</FromCity>
      <FromState>CA</FromState>
      <FromPostalCode>90245</FromPostalCode>
      <FromPhone>5555555555</FromPhone>
      <ToName>John Smith</ToName>
      <ToAddress1>221B Baker St</ToAddress1>
      <ToCity>London</ToCity>
      <ToCountryCode>GB</ToCountryCode>
   </LabelRequest>

Sample International GetPostageLabel Response

<GetPostageLabelResponse xmlns="www.envmgr.com/LabelService">
   <LabelRequestResponse>
      <Status>0</Status>
      <Label>
         <Image PartNumber="1">iVBORw0KGgoAAAANSUhEUgAABtsAAASDCAIAAACXxhfd...</Image>
         <Image PartNumber="2">iVBORw0KGgoAAAANSUhEUgAABtsAAASDCAIAAACXxhfd...</Image>
         <Image PartNumber="3">iVBORw0KGgoAAAANSUhEUgAABtsAAASDCAIAAACXxhfd...</Image>
         <Image PartNumber="4">iVBORw0KGgoAAAANSUhEUgAABtsAAASDCAIAAACXxhfd...</Image>
      </Label>
      <CustomsNumber>CJ501214385US</CustomsNumber>
      <TrackingNumber>CJ501214385US</TrackingNumber>
      <FinalPostage>46.08</FinalPostage>
      <TransactionID>8</TransactionID>
      <TransactionDateTime>20171109231948</TransactionDateTime>
      <PostmarkDate>20171110</PostmarkDate>
      <PostageBalance>244.42</PostageBalance>
      <CostCenter>0</CostCenter>
      <RequesterID>lxxx</RequesterID>
      <ReferenceID2/>
      <ReferenceID3/>
      <ReferenceID4/>
      <SDRValue/>
   </LabelRequestResponse>
</GetPostageLabelResponse>
  1. Point your request to the sandbox server.
  2. Run the GetPostageLabel API method on the right. For full details of the call, see GetPostageLabel in the API Reference below.
  3. Notice that the LabelType = International and LabelSubtype attribute is Integrated. This is recommended so that ELS can identify the custom form required for your shipment.
  4. Description of the elements:
    • <RequesterID> is required to specify who is making the request.
    • <CustomsInfo> is how you enter the customs information required to ship the parcel. This example has only one item, but you can enter multiple line items if you are shipping more than one item.
    • <ToPostalCode> is required when the country is Canada.
  5. When you execute the request using your credentials, you'll receive up to four <Image> objects for all the labels and forms required to ship. These will all be returned in base64, just like the label for your domestic label was.

International Customs Labels

The Endicia Label Server offers full support for USPS-approved integrated customs forms. Customs forms are printed in a convenient 6×4 label format to streamline your workflow. Support for customs forms in Endicia Label Server includes the following capabilities:

LabelType Usage
International For mailing to countries outside the United States.
Domestic For mailing to: APO/FPO/DPO addresses, US Territories and Possessions, and Freely Associated States (except Puerto Rico (PR) and US Virgin Islands (VI), which do not require a customs form. Set LabelType to "Default").

Cancel Label

Sample GetRefund Request

<RefundRequest>
  <RequesterID>lxxx</RequesterID>
  <RequestID>3</RequestID>
  <CertifiedIntermediary>
    <AccountID>9999999</AccountID>
    <PassPhrase>ABCDEFGHIJK</PassPhrase>
  </CertifiedIntermediary>
  <PicNumbers>
    <PicNumber>CJ501214385US</PicNumber>
  </PicNumbers>
</RefundRequest>

Sample GetRefund Response

<RefundResponse>
  <AccountID>9999999</AccountID>
  <RequesterID>lxxx</RequesterID>
  <RequestID>3</RequestID>
  <Refund PicNumber="CJ501214385US"  TransactionId="0" PieceNumber="0">
    <RefundStatus>Approved</RefundStatus>
    <RefundStatusMessage>Electronic RC RC_SUCCESS Transaction date 2017-Nov-09
      23:19:55.593 mail class International mail sub class Priority Mail International
      PicNumber CJ501214385US CustomsId CJ501214385US</RefundStatusMessage>
  </Refund>
  <FormId>99999</FormId>
  <BatchId>999999</BatchId>
</RefundResponse>

With the USPS, you are charged for live postage when you print the label. In order to request a refund of the postage, you must void or cancel a label. Since a postage label was created, the USPS must take steps to ensure that the label is not used before authorizing a refund.

As a result, it takes the USPS about two weeks to approve a refund request.

To create your refund request:

  1. Point your request to the sandbox server.
  2. Run the RefundRequest API method on the right. For full details of the call, see GetRefund in the API Reference below.
  3. Description of the elements:
    • The <PicNumbers> node contains <PicNumber>elements. You can request a refund for multiple mail pieces in a single request.
    • The <PicNumber> element contains the tracking number for the mail piece. This number is returned in the <TrackingNumber> of the Label Request Response.
    • Note that when a test label is produced (Test=YES in the GetPostageLabel request), a unique tracking number will not be returned, and no data will be stored in the database. Therefore, you cannot request a refund on a test transaction.
    • In addition to <PicNumbers>, you can also use the <PieceNumber> under the <PieceNumbers> node if you prefer. It requires the <TransactionID> value from the GetPostageLabel Response.

Track a Package

Sample StatusRequest Request

<StatusRequest xmlns="www.envmgr.com/LabelService">
  <PackageStatusRequest>
    <RequesterID>lxxx</RequesterID>
    <RequestID>5</RequestID>
    <CertifiedIntermediary>
      <AccountID>9999999</AccountID>
      <PassPhrase>ABCDEFGHIJK</PassPhrase>
    </CertifiedIntermediary>
    <RequestOptions PackageStatus="CURRENT" />
    <PicNumbers>
      <PicNumber>00040000999999999999</PicNumber>
    </PicNumbers>
  </PackageStatusRequest>
</StatusRequest>

Sample StatusRequest Response

<StatusRequestResponse xmlns="www.envmgr.com/LabelService">
  <PackageStatusResponse StartingTransactionID="1001234567" EndingTransactionID="1001234569" CompleteDataSet="true">
    <Status>0</Status>
    <PackageStatus>
      <StatusResponse>
        <PicNumber>00040000999999999999</PicNumber>
        <PieceId>123456</PieceId>
        <TransactionID>1001234568</TransactionID>
        <PackageStatusEventList>
          <StatusEventList>
            <StatusCode>I   </StatusCode>
            <StatusDescription>Mail piece was scanned in ZIP code 90247 on Nov 18</StatusDescription>
            <EventDateTime>11/14/2017 2:47:51 PM</EventDateTime>
            <TrackingSummary />
            <TrackingResults />
          </StatusEventList>
        </PackageStatusEventList>
      </StatusResponse>
    </PackageStatus>
  </PackageStatusResponse>
</StatusRequestResponse>

After shipping a package, most integrators also need to periodically check on the status of a package. The <StatusRequest> API method retrieves the requested parcels' most recent tracking events.

To begin tracking, identify either the package PicNumber, PieceNumber, or your Endicia tracking ID.

  1. Point your request to the sandbox server.
  2. Run the StatusRequest API Method on the right. For full details of the call, see StatusRequest in the API Reference below.
  3. Description of the Elements:
    • PicNumbers, PieceNumbers, TransactionIds, and ReferenceIds are all used for searching for packages.
    • CostCenter, ReferenceID, and StartingTransactionID are all used as filters for the results returned.
    • PackageStatus is used to request either the current or full status history of requested packages.
  4. The response returned depends on the value specified in PackageStatus -- either the full history or current status for requested packages will be returned.

API Reference

CalculatePostageRate

To calculate the postage and fees for a single mailpiece, use the CalculatePostageRate or the CalculatePostageRateXML web method of the Endicia Label Server Web Service.

When requesting for rates for services, you must explicitly specify each service that you are requesting or that service will not be included in the <TotalAmount> element. We recommend that you also set the PostagePrice attribute to “TRUE” so that ELS will return the <Fees> node which will include the price next to the service requested.

For further information, please see View Shipping Rates in the quick start guide above.

CalculatePostageRate Request

<CalculatePostageRate> Request

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">
        <MailpieceShape>string</MailpieceShape>
        <MailClass>string</MailClass>
        <WeightOz>string</WeightOz>
        <PackageTypeIndicator>string</PackageTypeIndicator>
        <DateAdvance>numeric</DateAdvance>
        <Pricing>string</Pricing>
        <SundayHolidayDelivery>string</SundayHolidayDelivery>
        <LiveAnimalSurcharge>string</LiveAnimalSurcharge>
        <Extension>string</Extension>
        <MailpieceDimensions>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
        </MailpieceDimensions>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <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" />
        <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>
        <FromCountryCode>string</FromCountryCode>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
      </PostageRateRequest>
    </CalculatePostageRate>
  </soap:Body>
</soap:Envelope>

Element Type/Value Description
ResponseVersion 0 or 1 Default (0). Returns basic Services validation. (1) Returns validated (STC) Services.
MailpieceShape
<MailpieceShape> Datatype Card
Letter
Flat
Parcel
LargeParcel
IrregularParcel
FlatRateEnvelope
FlatRateLegalEnvelope
FlatRatePaddedEnvelope
FlatRateGiftCardEnvelope
FlatRateWindowEnvelope
FlatRateCardboardEnvelope
SmallFlatRateEnvelope
SmallFlatRateBox
MediumFlatRateBox
LargeFlatRateBox
DVDFlatRateBox
LargeVideoFlatRateBox
RegionalRateBoxA
RegionalRateBoxB
LargeFlatRateBoardGameBox
HalfTrayBox
FullTrayBox
EMMTrayBox
FlatTubTrayBox
Shape of the mailpiece.
MailClass
MailClasses Datatype PriorityExpress
First
LibraryMail
MediaMail
ParcelSelect
RetailGround
Priority
PriorityMailExpressInternational
FirstClassMailInternational
FirstClassPackageInternationalService
PriorityMailInternational
Calculate rates for all applicable specified mail classes, domestic or International.
WeightOz
Numeric Weight of the package, in ounces.
PackageTypeIndicator Null OR Softpack Package Type is regular (Default). Commercial Plus Cubic price for the soft pack packaging alternative.
DateAdvance Numeric
(Valid values: 0 to 7)
The number of days to advance date on the indicium. When used, this element advances the date on the indicium by the number of days selected from the range of values. Default range: (0-7) days.
Pricing Retail Retail pricing—used only for Shared PES accounts.
SundayHolidayDelivery FALSE OR SUNDAY OR HOLIDAY Specify delivery on Sunday or holiday (Default FALSE). For more information, seePriority Mail Express Sunday and Holiday Service
LiveAnimalSurcharge TRUE or FALSE Used only for shipping live animals, such as day-old chicks, bees, or other live poultry Surcharge is based on weight and is only added if the destination zone is greater than 4.
Extension String
(10 Characters)
Customer’s phone extension
MailpieceDimensions
<Dimensions> Dimensions of the mailpiece.
Show <Dimensions> Object
Element Type/Value Description
Length Numeric Length of the mailpiece. For best rates, always enter the longest dimension as the length.
Width Numeric Width of the mailpiece.
Height Numeric Height (or thickness) of the mailpiece.
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
CertifiedIntermediary CertifiedIntermediary Certified Intermediary (CI) account authentication information.
Show CertifiedIntermediary
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

MailClass
MailClasses Datatype PriorityExpress
First
LibraryMail
MediaMail
ParcelSelect
RetailGround
Priority
PriorityMailExpressInternational
FirstClassMailInternational
FirstClassPackageInternationalService
PriorityMailInternational

Calculate rates for all applicable specified mail classes, domestic or International.
DateAdvance Numeric
(Valid values: 0 to 7)
The number of days to advance date on the indicium. When used, this element advances the date on the indicium by the number of days selected from the range of values. Default range: (0-7) days.
WeightOz Numeric Weight of the package, in ounces.
MailpieceShape

MailPiece Shape Datatype Card
Letter
Flat
Parcel
LargeParcel
IrregularParcel
FlatRateEnvelope
FlatRateLegalEnvelope
FlatRatePaddedEnvelope
FlatRateGiftCardEnvelope
FlatRateWindowEnvelope
FlatRateCardboardEnvelope
SmallFlatRateEnvelope
SmallFlatRateBox
MediumFlatRateBox
LargeFlatRateBox
DVDFlatRateBox
LargeVideoFlatRateBox
RegionalRateBoxA
RegionalRateBoxB
LargeFlatRateBoardGameBox
HalfTrayBox
FullTrayBox
EMMTrayBox
FlatTubTrayBox

Shape of the mailpiece.
MailpieceDimensions Dimensions Object Dimensions of the mailpiece.
Show Dimensions Object
Element Type/Value Description
Length Numeric Length of the mailpiece. For best rates, always enter the longest dimension as the length.
Width Numeric Width of the mailpiece.
Height Numeric Height (or thickness) of the mailpiece.
Machinable TRUE or FALSE If True, package is machinable. (Default). If false, package is non-machinable.
DeliveryTimeDays TRUE or FALSE Return Delivery time in days for Priority and Priority Mail Express. True will include delivery days in the response. False (default) will not include delivery days in the response.
EstimatedDeliveryDate TRUE or FALSE Estimated delivery date. True will include Estimated delivery date in the response. False (Default) does not include estimated delivery date in the response.Note: Applies only to Priority and Priority Mail Express. This element is dependent on DeliveryTimeDays. EstimatedDeliveryDate is populated in the response when both EstimatedDeliveryDate and DeliveryTimeDays are TRUE.
Services

Services Attributes DeliveryConfirmation
MailClassOnly
CertifiedMail
COD
ElectronicReturnReceipt
InsuredMail
RegisteredMail
RestrictedDelivery
ReturnReceipt
SignatureConfirmation
SignatureService
HoldForPickup
MerchandiseReturnService
OpenAndDistribute
AdultSignature
AdultSignatureRestrictedDelivery
AMDelivery

Special Services requested for the package. See USPS and Endicia Additional Services for details.
FromCountryCode String
(2 Characters)
LIMITED USE. For international returns from countries other than the US. Currently supported for France (FR) only.
FromPostalCode String
(5 Characters)
Sender’s postal code. The format is ZIP5.
ToPostalCode String
(15 Characters)
Recipient’s postal code. For domestic mail, the format is ZIP5 (required).For international mail (optional), up to 15 digits are allowed.
ToCountryCode String
(2 Characters)
Two character country code of the recipient’s country. Required for international mail. For a list of valid country codes, see the Country Code Table.
ShipDate Date
(MM/DD/YYYY)

Date mailpiece is shipped. Required for Priority Mail Express Sunday and Holiday Delivery Service. Ignored for other mail classes.
ShipTime Time
(HH:MM AM or HH:MM PM)

Time mailpiece is shipped. Applies only to Priority Mail Express Sunday and Holiday Delivery Service. Ignored for other mail classes.

If this element is not supplied, it defaults to 12:01 AM.

IsConsolidator TRUE or FALSE Rate Consolidator "no-postage" Label
DeliveryTimeDays TRUE or FALSE Delivery time in days for Priority and Priority Mail Express. Default is False.
EstimatedDeliveryDate TRUE or FALSE Estimated delivery date.
Note: Applies only to Priority and Priority Mail Express. This element is dependent on DeliveryTimeDays. EstimatedDeliveryDate is populated in the response when both EstimatedDeliveryDate and DeliveryTimeDays are TRUE. Default is FALSE.

ContentsType
ContentsTypes Documents
Gift
Merchandise
Other
ReturnedGoods
Sample
HumanitarianDonation
DangerousGoods
Category of the customs items.
ResponseOptions   Optional XML elements to include in the PostageRateResponse.
PostagePrice TRUE or FALSE TRUE means the response contains the PostagePrice node.

ResponseVersion

The ResponseVersion attribute provides the option to validate against the Service Type Code (STC) database to ensure that a combination of services within the MailClass and MailpieceShape is valid.

CalculatePostageRate Response

<CalculatePostageRate> Response

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>
          </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" />
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
        </PostagePrice>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
          </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" />
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
        </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>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
Postage <Postage> Object Postage price for requested mail service. The response will not contain this node if PostagePrice in ResponseOptions is set to TRUE
Show <Postage> Object
Element Type/Value Description
MailService String (50 Characters) Mail Service.
Rate Currency Calculated postage price including all fees.
PostagePrice <PostagePrice> Object Postage price for transaction.
Show <PostagePrice> Object
Element Type/Value Description
TotalAmount Currency Attribute of <PostagePrice> defining total amount of postage and fees. This value is also copied to the FinalPostage element.
Postage <Postage> Object Object breakdown of total postage assessed.
Show <Postage> Object
Element Type/Value Description
TotalAmount Currency Total amount of postage.
MailService String
(50 Characters)
Description of MailClass requested. For instance, a PostagePrice object with MailClass PriorityMailInternational will display Priority Mail International for the MailService.
Zone String
(0 (local zone) through 9)
Number of postal rate zones between the sender’s and recipient’s ZIP Codes. Applies only to domestic mail.
IntraNDC true or false Zone is Intra-NDC.
Zone is Inter-NDC. Applies only to domestic mail.
Pricing
<Pricing> Datatype Commercial
CommercialBase
CommercialPlus
NSA
Retail
USPS pricing level associated with returned postage estimate.
Fees <Fees> Object Object breakdown of fees associated with postage
Show <Fees> Object
Element Type/Value Description
TotalAmount Currency Total amount of fees.
CertificateOfMailing Currency Certificate of Mailing fee.
For future use.
CertifiedMail Currency Certified Mail fee.
CollectOnDelivery Currency Collect on Delivery (COD) fee.
For future use.
DeliveryConfirmation Currency Delivery Confirmation fee.
ElectronicReturnReceipt Currency Electronic Return Receipt fee.
InsuredMail Currency Insured Mail fee.
RegisteredMail Currency Registered Mail fee.
For future use.
RestrictedDelivery Currency Restricted Delivery fee.
ReturnReceipt Currency Return Receipt fee.
ReturnReceiptForMerchandise Currency Return Receipt for Merchandise fee.
For future use.
SignatureConfirmation Currency Signature Confirmation fee.
SpecialHandling Currency Special Handling fee.
For future use.
AdultSignature Currency Adult Signature fee.
AdultSignatureRestrictedDelivery Currency Adult Signature Restricted Delivery fee.
LiveAnimalSurcharge Currency Live Animal Surcharge fee.
DeliveryTimeDays Numeric (1 Digit) Delivery time in days
EstimatedDeliveryDate Date
(d/m/yyyy)
Estimated delivery date
Note: Applies only to Priority and Priority Mail Express.
AMDelivery Numeric AM Delivery fee for Priority Mail Express packages.
GroupedExtraServices <GroupedExtraServices> Object Container for Extra Services and associated fees.
Show <GroupedExtraServices>Object
Element Type/Value Description
Services SignatureConfirmation;RestrictedDelivery
CertifiedMail;RestrictedDelivery
CertifiedMail;AdultSignature
CertifiedMail;AdultSignatureRestrictedDelivery
Extra services subscribed
FeeAmount Currency Amount for Grouped Service

CalculatePostageRates

To calculate the postage and fees for multiple mail classes for a mailpiece, use the CalculatePostageRates or the CalculatePostageRatesXML web method of the Endicia Label Server Web Service. This method is typically used to list all the available rates given the rate ingredients submitted in the request.

The ResponseVersion attribute for this call is used when integrators are searching for all MailClasses that offer a specified extra service(s). To execute such a search, the ResponseVersion must be set to “1”. Setting the ResponseVersion to “0” may incorrectly return MailClasses were the service does not qualify or apply.

For further information, please see View Shipping Rates in the quick start guide above.

CalculatePostageRates Request

<CalculatePostageRates> Request

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

<?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>
    <CalculatePostageRates xmlns="www.envmgr.com/LabelService">
      <PostageRatesRequest ResponseVersion="0 or 1">
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <MailClass>string</MailClass>
        <WeightOz>double</WeightOz>
        <MailpieceShape>string</MailpieceShape>
        <MailpieceDimensions>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
        </MailpieceDimensions>
        <Machinable>string</Machinable>
        <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" />
        <CODAmount>double</CODAmount>
        <InsuredValue>double</InsuredValue>
        <RegisteredMailValue>double</RegisteredMailValue>
        <FromPostalCode>string</FromPostalCode>
        <ToPostalCode>string</ToPostalCode>
        <ToCountry>string</ToCountry>
        <ToCountryCode>string</ToCountryCode>
        <DateAdvance>int</DateAdvance>
        <Extension>string</Extension>
        <DeliveryTimeDays>string</DeliveryTimeDays>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
      </PostageRatesRequest>
    </CalculatePostageRates>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
ResponseVersion
0 or 1 Default (0). Returns basic Services validation. (1) Returns validated (STC) Services. See ResponseVersion
RequesterID
String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
CertifiedIntermediary
<CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

MailClass
Domestic or International Calculate rates for all applicable specified mail classes, domestic or International.
DateAdvance
Numeric
(Valid values: 0 to 7)
The number of days to advance date on the indicium. When used, this element advances the date on the indicium by the number of days selected from the range of values. Default range: (0-7) days.
WeightOz
Numeric Weight of the package, in ounces.
MailpieceShape

<MailpieceShape> Datatype Card
Letter
Flat
Parcel
LargeParcel
IrregularParcel
FlatRateEnvelope
FlatRateLegalEnvelope
FlatRatePaddedEnvelope
FlatRateGiftCardEnvelope
FlatRateWindowEnvelope
FlatRateCardboardEnvelope
SmallFlatRateEnvelope
SmallFlatRateBox
MediumFlatRateBox
LargeFlatRateBox
DVDFlatRateBox
LargeVideoFlatRateBox
RegionalRateBoxA
RegionalRateBoxB
LargeFlatRateBoardGameBox
HalfTrayBox
FullTrayBox
EMMTrayBox
FlatTubTrayBox

Shape of the mailpiece.
MailpieceDimensions
<Dimensions> Dimensions of the mailpiece.
Show <Dimensions> Object
Element Type/Value Description
Length Numeric Length of the mailpiece. For best rates, always enter the longest dimension as the length.
Width Numeric Width of the mailpiece.
Height Numeric Height (or thickness) of the mailpiece.
Machinable
TRUE or FALSE If true (Default), package is machinable. If false, a surcharge may apply.
DeliveryTimeDays
TRUE or FALSE Return Delivery time in days for Priority and Priority Mail Express. False (Default) will not include delivery days in the response.
EstimatedDeliveryDate
TRUE or FALSE Estimated delivery date. False (Default) does not include estimated delivery date in the response.
Note: Applies only to Priority and Priority Mail Express. This element is dependent on DeliveryTimeDays. EstimatedDeliveryDate is populated in the response when both EstimatedDeliveryDate and DeliveryTimeDays are TRUE.
ContentsType
ContentsTypes Documents
Gift
Merchandise
Other
ReturnedGoods
Sample
HumanitarianDonation
DangerousGoods
Category of the customs items.
Services
<Services> Object Object container for all special services requested for the package.
Show <Services> Object

Service Attribute Name Values Notes
DeliveryConfirmation OFF or ON USPS Tracking Service. Default for all parcels – no need to manually select. Free for most mail classes.
Also available for the following international mail categories: First-Class Package International Service parcels, Priority Mail International Flat Rate Envelopes, and Small Flat Rate Boxes. See USPS Manual for current countries.
For destinations where USPS Tracking is not available, such as some APO/FPO/DPO addresses or US Territories/Possessions/Freely Associated States, you may need to include this attribute and set it to OFF.
SignatureConfirmation OFF or ON Obtains a signature on delivery. Once delivered, you can view the signature at USPS by entering your tracking number into the dialog.
Not available to APO/FPO/DPO destinations.
To obtain tracking information and a signature image file, you must have your own Mailer ID assigned from the USPS and have it applied to your Endicia account. You can then obtain this information from the USPS data center.
Endicia does not receive or supply this information.
CertifiedMail OFF or ON Used with Return Receipt or Electronic Return Receipt to obtain a physical record of proof of delivery.
The default value is ON for LabelType=”CertifiedMail”; otherwise, it is OFF. Available for First-Class Letters, Flats, and parcels and for Priority Mail. Certified Mail is the only tracking option available for some US Territories and Possessions.
USPS Label 3800-N is required.
RegisteredMail OFF or ON Used with Return Receipt or Electronic Return Receipt. Includes proof of mailing (time and date) as well as date and time of delivery or attempted delivery.
When choosing Registered Mail, you must also include the <RegisteredValue> element described below.
USPS Label 200-N is required.
Note: Effective January 22, 2017, Registered Mail is no longer available for First-Class Package Service nor Priority Mail International.
InsuredMail OFF
Endicia
UspsOnline
ThirdParty
Endicia Insurance provides up to $10,000 insurance. Endicia insurance fee is not included in the postage price. It is billed to your account. See Insurance for details.
USPS insurance is not allowed when Stealth or ReplyPostage is set to TRUE. The USPS allows up to $5,000 insurance.
Third party insurance may also be requested. This applies to retail accounts only
COD OFF
ON
<CODAmount> element is required.
Must affix a completed COD Form 3816 to the mailpiece and take it to the retail USPS counter, or print the forms using the COD3816 object.
HoldForPickup OFF or ON See Hold For Pickup in the appendix.
OpenAndDistribute OFF or ON See Open and Distribute in the appendix.
RestrictedDelivery OFF or ON Requires that only the named person in the <ToName> element of the Label Request will be given the mailpiece. Identification will be required.
Available only with Signature Confirmation, Certified Mail, Registered Mail, UspsOnline Insured Mail over $500, COD, or Adult Signature.
ReturnReceipt OFF or ON Can only be used with LabelType Default or DestinationConfirm. Not supported for International Mail.
You must affix ad completed Return Receipt (USPS Form 3811) to the mail piece, and take it to a USPS retail counter.  
ElectronicReturnReceipt OFF or ON Same restrictions as ReturnReceipt.
To receive Electronic Return Receipt delivery information, you must have your own Mailer ID assigned from the USPS and have it applied to your Endicia account. You can then obtain this information from the USPS data center.
A physical form is not required. The equivalent information will be returned electronically.
Endicia does not receive or supply this information.
AdultSignature OFF or ON Requires the signature of someone 21 years of age or older at the receipient’s address
AdultSignatureRestrictedDelivery OFF or ON Requires the the addressee named in the <ToName> element be 21 years of age or older. If the specified individual is not 21 or over, the mailpiece will be returned to the sender.
AMDelivery OFF or ON AMDelivery service for Priority Mail Express is requested

FromCountryCode
String
(2 Characters)
LIMITED USE. For international returns from countries other than the US. Currently supported for France (FR) only.
FromPostalCode
String
(5 Characters)
Sender’s postal code. The format is ZIP5.
ToPostalCode
String
(15 Characters)
Recipient’s postal code. For domestic mail, the format is ZIP5 (required).For international mail (optional), up to 15 digits are allowed.
ToCountryCode
String
(2 Characters)
Two character country code of the recipient’s country. Required for international mail. For a list of valid country codes, see the Country Code Table.

ResponseVersion

The ResponseVersion attribute provides the option to validate against the Service Type Code (STC) database to ensure that a combination of services within the MailClass and MailpieceShape is valid.

CalculatePostageRates Response

<CalculatePostageRates> Response

<?xml version="1.0" encoding="utf-8"?>
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>
    <CalculatePostageRatesResponse xmlns="www.envmgr.com/LabelService">
      <PostageRatesResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
          </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" />
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
        </PostagePrice>
        <PostagePrice>
          ...
        </PostagePrice>
</PostageRatesResponse>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
PostagePrice List of <PostagePrice> Objects Postage price for transaction.
Show <PostagePrice> Object
Element Type/Value Description
TotalAmount Currency Attribute of <PostagePrice> defining total amount of postage and fees. This value is also copied to the FinalPostage element.
Postage <Postage> Object Object breakdown of total postage assessed.
Show <Postage> Object
Element Type/Value Description
TotalAmount Currency Total amount of postage.
MailService String
(50 Characters)
Description of MailClass requested. For instance, a PostagePrice object with MailClass PriorityMailInternational will display Priority Mail International for the MailService.
Zone String
(0 (local zone) through 9)
Number of postal rate zones between the sender’s and recipient’s ZIP Codes. Applies only to domestic mail.
IntraNDC true or false Zone is Intra-NDC.
Zone is Inter-NDC. Applies only to domestic mail.
Pricing
<Pricing> Datatype Commercial
CommercialBase
CommercialPlus
NSA
Retail
USPS pricing level associated with returned postage estimate.
Fees <Fees> Object Object breakdown of fees associated with postage
Show <Fees> Object
Element Type/Value Description
TotalAmount Currency Total amount of fees.
CertificateOfMailing Currency Certificate of Mailing fee.
For future use.
CertifiedMail Currency Certified Mail fee.
CollectOnDelivery Currency Collect on Delivery (COD) fee.
For future use.
DeliveryConfirmation Currency Delivery Confirmation fee.
ElectronicReturnReceipt Currency Electronic Return Receipt fee.
InsuredMail Currency Insured Mail fee.
RegisteredMail Currency Registered Mail fee.
For future use.
RestrictedDelivery Currency Restricted Delivery fee.
ReturnReceipt Currency Return Receipt fee.
ReturnReceiptForMerchandise Currency Return Receipt for Merchandise fee.
For future use.
SignatureConfirmation Currency Signature Confirmation fee.
SpecialHandling Currency Special Handling fee.
For future use.
AdultSignature Currency Adult Signature fee.
AdultSignatureRestrictedDelivery Currency Adult Signature Restricted Delivery fee.
LiveAnimalSurcharge Currency Live Animal Surcharge fee.
DeliveryTimeDays Numeric (1 Digit) Delivery time in days
EstimatedDeliveryDate Date
(d/m/yyyy)
Estimated delivery date
Note: Applies only to Priority and Priority Mail Express.
AMDelivery Numeric AM Delivery fee for Priority Mail Express packages.
GroupedExtraServices <GroupedExtraServices> Object Container for Extra Services and associated fees.
Show <GroupedExtraServices>Object
Element Type/Value Description
Services SignatureConfirmation;RestrictedDelivery
CertifiedMail;RestrictedDelivery
CertifiedMail;AdultSignature
CertifiedMail;AdultSignatureRestrictedDelivery
Extra services subscribed
FeeAmount Currency Amount for Grouped Service

BuyPostage

To add postage to an account, use the BuyPostage or the BuyPostageXML web method of the Endicia Label Server Web Service.

For further information, please see Buy Postage in the quick start guide above.

BuyPostage Request

<BuyPostage> Request

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

<?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>
    <BuyPostage xmlns="www.envmgr.com/LabelService">
      <RecreditRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <RecreditAmount>string</RecreditAmount>
      </RecreditRequest>
    </BuyPostage>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

RecreditAmount Currency or
<RecreditAmount> Card
10
25
50
100
250
500
1000
2500
5000
7500
10000
20000

Amount of postage, in dollars, to add to the account. Either use a defined amount from the list or enter any value up to 99999.99. The minimum amount of postage that can be purchased is $10. The maximum amount is based on the settings of the account.

Notes

A customer can apply directly with Endicia support staff (support@endicia.com) to have the postage purchase limits on an account increased after they have used the account and have established a postage buying pattern (usually after a few weeks).

For additional purchase methods, please see Endicia Bank-to-Bank Postage Payment Options

BuyPostage Response

<BuyPostage> Response

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>
    <BuyPostageResponse xmlns="www.envmgr.com/LabelService">
      <RecreditRequestResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <SerialNumber>int</SerialNumber>
          <PostageBalance>decimal</PostageBalance>
          <AscendingBalance>decimal</AscendingBalance>
          <AccountStatus>string</AccountStatus>
          <DeviceID>string</DeviceID>
          <ReferenceID>string</ReferenceID>
        </CertifiedIntermediary>
        <TransactionID>long</TransactionID>
        <ControlRegister>decimal</ControlRegister>
      </RecreditRequestResponse>
    </BuyPostageResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
SerialNumber Numeric
(12 Digits)
The Serial Number of the last item created on the account.
PostageBalance Currency Remaining postage balance after re-credit in dollars and cents (mils).
AscendingBalance Currency Total amount of postage printed (after re-credit) in dollars and cents (mils).
Account Status String
(1 Character)
Account Status flag: A for Active
DeviceID String
(12 Characters)
The account's 12 character Device ID (that appears in the indicium).
RecreditAmount Currency, or
<RecreditAmount> Card
10
25
50
100
250
500
1000
2500
5000
7500
10000
20000
Amount of postage, in dollars, to add to the account. Either use a defined amount from the list or enter any value up to 99999.99. The minimum amount of postage that can be purchased is $10. The maximum amount is based on the settings of the account.

GetPostageLabel

To request a shipping label, use the GetPostageLabel or the GetPostageLabelXML web method of the Endicia Label Server Web Service.

For further information, please see Create Label in the quick start guide above.

GetPostageLabel Request

<GetPostageLabel> Request

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

<?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>
    <GetPostageLabel xmlns="www.envmgr.com/LabelService">
      <LabelRequest Test="string"
                    LabelType="string"
                    LabelSubtype="string"
                    LabelSize="string"
                    ImageFormat="string"
                    ImageResolution="string"
                    ImageRotation="string"
                    LabelTemplate="string">
        <MailpieceShape>string</MailpieceShape>
        <MailClass>string</MailClass>
        <WeightOz>string</WeightOz>
        <PackageTypeIndicator>string</PackageTypeIndicator>
        <DateAdvance>numeric</DateAdvance>
        <Pricing>string</Pricing>
        <SundayHolidayDelivery>string</SundayHolidayDelivery>
        <LiveAnimalSurcharge>string</LiveAnimalSurcharge>
        <Extension>string</Extension>
        <MailpieceDimensions>
          <Length>double</Length>
          <Width>double</Width>
          <Height>double</Height>
        </MailpieceDimensions>
        <RequesterID>string</RequesterID>
        <AccountID>string</AccountID>
        <PassPhrase>string</PassPhrase>
        <AutomationRate>string</AutomationRate>
        <Machinable>string</Machinable>
        <ServiceLevel>string</ServiceLevel>
        <SortType>string</SortType>
        <IncludePostage>string</IncludePostage>
        <ReplyPostage>string</ReplyPostage>
        <ShowReturnAddress>string</ShowReturnAddress>
        <Stealth>string</Stealth>
        <ValidateAddress>string</ValidateAddress>
        <SignatureWaiver>string</SignatureWaiver>
        <NoWeekendDelivery>string</NoWeekendDelivery>
        <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" />
        <CostCenter>int</CostCenter>
        <Value>float</Value>
        <CODAmount>double</CODAmount>
        <RegisteredMailValue>double</RegisteredMailValue>
        <Description>string</Description>
        <IntegratedFormType>string</IntegratedFormType>
        <CustomsFormType>string</CustomsFormType>
        <CustomsFormImageFormat>string</CustomsFormImageFormat>
        <CustomsFormImageResolution>string</CustomsFormImageResolution>
        <OriginCountry>string</OriginCountry>
        <ContentsType>string</ContentsType>
        <ContentsExplanation>string</ContentsExplanation>
        <NonDeliveryOption>string</NonDeliveryOption>
        <ReferenceID>string</ReferenceID>
        <ReferenceID2>string</ReferenceID2>
        <ReferenceID3>string</ReferenceID3>
        <ReferenceID4>string</ReferenceID4>
        <PartnerCustomerID>string</PartnerCustomerID>
        <PartnerTransactionID>string</PartnerTransactionID>
        <BpodClientDunsNumber>string</BpodClientDunsNumber>
        <RubberStamp1>string</RubberStamp1>
        <RubberStamp2>string</RubberStamp2>
        <RubberStamp3>string</RubberStamp3>
        <EntryFacility>string</EntryFacility>
        <POZipCode>string</POZipCode>
        <ShipDate>string</ShipDate>
        <ShipTime>string</ShipTime>
        <CustomsInfo>
          <ContentsType>string</ContentsType>
          <ContentsExplanation>string</ContentsExplanation>
          <RestrictionType>string</RestrictionType>
          <RestrictionComments>string</RestrictionComments>
          <SendersCustomsReference>string</SendersCustomsReference>
          <ImportersCustomsReference>string</ImportersCustomsReference>
          <LicenseNumber>string</LicenseNumber>
          <CertificateNumber>string</CertificateNumber>
          <InvoiceNumber>string</InvoiceNumber>
          <NonDeliveryOption>string</NonDeliveryOption>
          <InsuredNumber>string</InsuredNumber>
          <EelPfc>string</EelPfc>
          <CustomsItems>
            <CustomsItem xsi:nil="true" />
            <CustomsItem xsi:nil="true" />
          </CustomsItems>
          <RecipientTaxID>string</RecipientTaxID>
          <DDPPayer>string</DDPPayer>
          <DDPNonPaymentOption>string</DDPNonPaymentOption>
        </CustomsInfo>
        <CustomsCertify>string</CustomsCertify>
        <CustomsSigner>string</CustomsSigner>
        <HfpEmailAddress>string</HfpEmailAddress>
        <HfpSMS>string</HfpSMS>
        <HfpFacilityID>string</HfpFacilityID>
        <MRSPermitNo>string</MRSPermitNo>
        <MRSPermitCityStateZIP>string</MRSPermitCityStateZIP>
        <MRSPermitFirm>string</MRSPermitFirm>
        <MRSPermitStreet>string</MRSPermitStreet>
        <MRSRMANumber>string</MRSRMANumber>
        <OpenAndDistributeFacilityType>string</OpenAndDistributeFacilityType>
        <OpenAndDistributeFacilityName>string</OpenAndDistributeFacilityName>
        <OpenAndDistributeTray>string</OpenAndDistributeTray>
        <OpenAndDistributeMailClassEnclosed>string</OpenAndDistributeMailClassEnclosed>
        <OpenAndDistributeMailClassOther>string</OpenAndDistributeMailClassOther>
        <GXGFedexTrackingNumber>string</GXGFedexTrackingNumber>
        <GXGUSPSTrackingNumber>string</GXGUSPSTrackingNumber>
        <PrintConsolidatorLabel>string</PrintConsolidatorLabel>
        <ResponseOptions PostagePrice="string" />
        <Token>string</Token>
        <CustomsSendersCopy>string</CustomsSendersCopy>
        <NoDate>string</NoDate>
        <MerchantID>string</MerchantID>
        <PrintScanBasedPaymentLabel>string</PrintScanBasedPaymentLabel>
        <SpecialContents>string</SpecialContents>
        <eVSOptions>
          <PermitNumber>string</PermitNumber>
          <eVSMailerId>string</eVSMailerId>
        </eVSOptions>
        <COD3816>
          <AS3816>string</AS3816>
          <USPSCA>string</USPSCA>
          <PMExpressReturn>string</PMExpressReturn>
          <OptionalEndorsement>string</OptionalEndorsement>
          <ReturnName>string</ReturnName>
          <ReturnCompany>string</ReturnCompany>
          <ReturnAddress1>string</ReturnAddress1>
          <ReturnAddress2>string</ReturnAddress2>
          <ReturnCity>string</ReturnCity>
          <ReturnState>string</ReturnState>
          <ReturnPostalCode>string</ReturnPostalCode>
        </COD3816>
        <EmailMiscNotes>string</EmailMiscNotes>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
        <AncillaryServiceEndorsement>string</AncillaryServiceEndorsement>
        <InsuredValue>string</InsuredValue>
        <FromName>string</FromName>
        <FromCompany>string</FromCompany>
        <ReturnAddress1>string</ReturnAddress1>
        <ReturnAddress2>string</ReturnAddress2>
        <ReturnAddress3>string</ReturnAddress3>
        <ReturnAddress4>string</ReturnAddress4>
        <FromCity>string</FromCity>
        <FromState>string</FromState>
        <FromPostalCode>string</FromPostalCode>
        <FromZIP4>string</FromZIP4>
        <FromCountry>string</FromCountry>
        <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>
        <ToPostalCode>string</ToPostalCode>
        <ToZIP4>string</ToZIP4>
        <ToDeliveryPoint>string</ToDeliveryPoint>
        <ToCountry>string</ToCountry>
        <ToCountryCode>string</ToCountryCode>
        <ToPhone>string</ToPhone>
        <ToEMail>string</ToEMail>
        <CustomsCountry1>string</CustomsCountry1>
        <CustomsDescription1>string</CustomsDescription1>
        <CustomsQuantity1>unsignedInt</CustomsQuantity1>
        <CustomsValue1>float</CustomsValue1>
        <CustomsWeight1>unsignedInt</CustomsWeight1>
        <CustomsCountry2>string</CustomsCountry2>
        <CustomsDescription2>string</CustomsDescription2>
        <CustomsQuantity2>unsignedInt</CustomsQuantity2>
        <CustomsValue2>float</CustomsValue2>
        <CustomsWeight2>unsignedInt</CustomsWeight2>
        <CustomsCountry3>string</CustomsCountry3>
        <CustomsDescription3>string</CustomsDescription3>
        <CustomsQuantity3>unsignedInt</CustomsQuantity3>
        <CustomsValue3>float</CustomsValue3>
        <CustomsWeight3>unsignedInt</CustomsWeight3>
        <CustomsCountry4>string</CustomsCountry4>
        <CustomsDescription4>string</CustomsDescription4>
        <CustomsQuantity4>unsignedInt</CustomsQuantity4>
        <CustomsValue4>float</CustomsValue4>
        <CustomsWeight4>unsignedInt</CustomsWeight4>
        <CustomsCountry5>string</CustomsCountry5>
        <CustomsDescription5>string</CustomsDescription5>
        <CustomsQuantity5>unsignedInt</CustomsQuantity5>
        <CustomsValue5>float</CustomsValue5>
        <CustomsWeight5>unsignedInt</CustomsWeight5>
        <EelPfc>string</EelPfc>
        <HfpFacilityName>string</HfpFacilityName>
        <HfpFacilityAddress1>string</HfpFacilityAddress1>
        <HfpFacilityCity>string</HfpFacilityCity>
        <HfpFacilityState>string</HfpFacilityState>
        <HfpFacilityPostalCode>string</HfpFacilityPostalCode>
        <HfpFacilityZIP4>string</HfpFacilityZIP4>
        <CostCenterAlphaNumeric>string</CostCenterAlphaNumeric>
        <ToCarrierRoute>string</ToCarrierRoute>
        <HazardousMaterial>
          <HazMatDescription>string</HazMatDescription>
          <HazMatPhone>string</HazMatPhone>
        </HazardousMaterial>
        <FromCountryCode>string</FromCountryCode>
      </LabelRequest>
    </GetPostageLabel>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Show <GetPostageLabel> Attributes
Test YES or NO Use sample postage for testing (YES) or use live postage (NO, Default).
LabelType
<LabelTypes> Datatype LabelTypes
Default
CertifiedMail
DestinationConfirm
Domestic
International
Create label based on Domestic or International mailclass. Also used to specify Certified Mail or IMB Domestic Confirmation labels.
LabelSubtype
<LabelSubtype> Datatype Integrated
Create an integrated customs form.
LabelSize
<LabelSizes> Datatype 4x6
3.5x5.25
4x4
4x5
4x4.5
DocTab
6x4
4x8
7x3
Dymo30384
EnvelopeSize10
Mailer7x5
7x4
8x3
Booklet
Eligible sizes for Default label: 4" W × 6" H (Default)
3.5”W x 5.25” H
4” W x 4” H
4" W × 5" H
4" W × 4.5" H
4" W × 6.75" H, Eltron Doc-Tab label
6" W × 4" H
4”W × 8” H (Prints shipment information on the doctab portion of the label)
Eligible sizes for DestinationConfirm label: 7" W × 3" H (Default)
6" W × 4" H
DYMO \#30384 2-part internet label (2.25" × 7.5")
\#10 Envelope (9.5” W x 4.125” H).
7" W × 5" H
Eligible sizes for CertifiedMail label: 4" W × 6" H (Default)
7" W × 4" H
8" W × 3" H
9" W × 6 "H envelope
\#10 Envelope
ImageFormat
<ImageFormat> Datatype EPL2
ZPLII
GIF
GIFMONOCHROME
JPEG
JPEGMONOCHROME
PNG
PNGMONOCHROME
BMPMONOCHROME
PDF
PDFVector
PDFVectorWithFonts
Specifies the encoding and color (if applicable) of the label being printed. For more information, see ImageFormats
ImageResolution
<DPI> Datatype 203
300
600
Used to specify resolution desired for print.
Image resolution defaults to 300 dpi for domestic labels as well as labels created using LabelType International.
Image resolution defaults to 203 for labels with ImageFormat EPL2 or ZPLII.
ImageRotation
<ImageRotation> Datatype None
Rotate90
Rotate180
Rotate270
Used to specify image rotation, if desired (no rotation by default).
For labels in EPL2 and ZPLII format, selecting Rotate180 prints from top of image buffer; selecting None prints from bottom of image buffer. Rotate90 and Rotate270 are not available for labels in EPL2 and ZPLII format.
LabelTemplate 50 Custom template or layout that overrides the generic label layout. Currently in Beta.
MailpieceShape
<MailpieceShape> Datatype Card
Letter
Flat
Parcel
LargeParcel
IrregularParcel
FlatRateEnvelope
FlatRateLegalEnvelope
FlatRatePaddedEnvelope
FlatRateGiftCardEnvelope
FlatRateWindowEnvelope
FlatRateCardboardEnvelope
SmallFlatRateEnvelope
SmallFlatRateBox
MediumFlatRateBox
LargeFlatRateBox
DVDFlatRateBox
LargeVideoFlatRateBox
RegionalRateBoxA
RegionalRateBoxB
LargeFlatRateBoardGameBox
HalfTrayBox
FullTrayBox
EMMTrayBox
FlatTubTrayBox
Shape of the mailpiece. (Default:Parcel)
Use LargeParcel instead of <MailpieceDimensions> object to indicate Balloon Rate.
If MailpieceShape is set to LargeParcel, it overrides the value supplied in <MailpieceDimensions>. Valid for Priority Mail and Parcel Select only.
IrregularParcel is used for First-Class Package Service (if applicable) and Parcel Select Lightweight only.
For more information, see LabelType, LabelSize, and MailpieceShape by MailClass
MailClass
MailClasses Datatype PriorityExpress
First
LibraryMail
MediaMail
ParcelSelect
RetailGround
Priority
PriorityMailExpressInternational
FirstClassMailInternational
FirstClassPackageInternationalService
PriorityMailInternational
Calculate rates for all applicable specified mail classes, domestic or International.
WeightOz Numeric Weight of the package, in ounces.
PackageTypeIndicator Null OR Softpack Package Type is regular (Default). Commercial Plus Cubic price for the soft pack packaging alternative.
DateAdvance Numeric
(Valid values: 0 to 7)
The number of days to advance date on the indicium. When used, this element advances the date on the indicium by the number of days selected from the range of values. Default range: (0-7) days.
Pricing Retail Retail pricing—used only for Shared PES accounts.
SundayHolidayDelivery FALSE OR SUNDAY OR HOLIDAY Speicfy delivery on Sunday or holiday (Default FALSE). For more information, seePriority Mail Express Sunday and Holiday Service
LiveAnimalSurcharge TRUE or FALSE Used only for shipping live animals, such as day-old chicks, bees, or other live poultry Surcharge is based on weight and is only added if the destination zone is greater than 4.
Extension String
(10 Characters)
Customer’s phone extension
MailpieceDimensions <Dimensions> Object Dimensions of the mailpiece. For more information, see Mailpiece Dimensions.
Show <Dimensions> Object
Element Type/Value Description
Length Numeric Length of the mailpiece. For best rates, always enter the longest dimension as the length.
Width Numeric Width of the mailpiece.
Height Numeric Height (or thickness) of the mailpiece.
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the partner making the request. Endicia assigns this ID.
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
AutomationRate TRUE or FALSE Use applicable automation rate for selected mail class. (Presort Only). By default, use retail price. Available only for letter shape mailpiece using First-Class.
Machinable TRUE or FALSE If a Parcel Select Ground mailpiece marked as machinable is over 35 lbs. in weight, it will automatically be charged the non-machinable price.
ServiceLevel NextDay2ndDayPOToAddressee Next Day/Second Day Post Office to Addressee Service. (PME Only)
SortType
<SortType> Datatype NDC
FiveDigit
MixedNDC
Nonpresorted
Presorted
SCF
SinglePiece
ThreeDigit
Sort level for applicable mail classes (Presort Only)
IncludePostage TRUE or FALSE Print postage on the label.
ReplyPostage TRUE or FALSE Print reply postage on the label, which means the Sender’s and Recipient’s address will be swapped when printing. Can be used with label type Default or DestinationConfirm. Not available for Priority Mail Express, international mail, integrated labels, or when Return Receipt is requested.
ShowReturnAddress TRUE or FALSE Print sender’s address on the label. Defaults to TRUE for integrated labels. For circumstances where ShowReturnAddress must be TRUE, see USPS Manual.
Stealth TRUE or FALSE Turn on the use of Stealth Postage or hidden postage price. (Default) For more information, see Stealth Postage™ Labels.
ValidateAddress TRUE or FALSE Validate all addresses. (Default). Note, bypassing address validation requires Partner to do address validation.
SignatureWaiver TRUE or FALSE Request waiver of signature for receipt of mailpiece (Default).
NoWeekendDelivery TRUE or FALSE Request that mailpiece should NOT be delivered on a Saturday (Default False).
Services <Services> Object Special Services requested for the package.
Show <Services> Object

Service Attribute Name Values Notes
DeliveryConfirmation OFF or ON USPS Tracking Service. Default for all parcels – no need to manually select. Free for most mail classes.
Also available for the following international mail categories: First-Class Package International Service parcels, Priority Mail International Flat Rate Envelopes, and Small Flat Rate Boxes. See USPS Manual for current countries.
For destinations where USPS Tracking is not available, such as some APO/FPO/DPO addresses or US Territories/Possessions/Freely Associated States, you may need to include this attribute and set it to OFF.
SignatureConfirmation OFF or ON Obtains a signature on delivery. Once delivered, you can view the signature at USPS by entering your tracking number into the dialog.
Not available to APO/FPO/DPO destinations.
To obtain tracking information and a signature image file, you must have your own Mailer ID assigned from the USPS and have it applied to your Endicia account. You can then obtain this information from the USPS data center.
Endicia does not receive or supply this information.
CertifiedMail OFF or ON Used with Return Receipt or Electronic Return Receipt to obtain a physical record of proof of delivery.
The default value is ON for LabelType=”CertifiedMail”; otherwise, it is OFF. Available for First-Class Letters, Flats, and parcels and for Priority Mail. Certified Mail is the only tracking option available for some US Territories and Possessions.
USPS Label 3800-N is required.
RegisteredMail OFF or ON Used with Return Receipt or Electronic Return Receipt. Includes proof of mailing (time and date) as well as date and time of delivery or attempted delivery.
When choosing Registered Mail, you must also include the <RegisteredValue> element described below.
USPS Label 200-N is required.
Note: Effective January 22, 2017, Registered Mail is no longer available for First-Class Package Service nor Priority Mail International.
InsuredMail OFF
Endicia
UspsOnline
ThirdParty
Endicia Insurance provides up to $10,000 insurance. Endicia insurance fee is not included in the postage price. It is billed to your account. See Insurance for details.
USPS insurance is not allowed when Stealth or ReplyPostage is set to TRUE. The USPS allows up to $5,000 insurance.
Third party insurance may also be requested. This applies to retail accounts only
COD OFF
ON
<CODAmount> element is required.
Must affix a completed COD Form 3816 to the mailpiece and take it to the retail USPS counter, or print the forms using the COD3816 object.
HoldForPickup OFF or ON See Hold For Pickup in the appendix.
OpenAndDistribute OFF or ON See Open and Distribute in the appendix.
RestrictedDelivery OFF or ON Requires that only the named person in the <ToName> element of the Label Request will be given the mailpiece. Identification will be required.
Available only with Signature Confirmation, Certified Mail, Registered Mail, UspsOnline Insured Mail over $500, COD, or Adult Signature.
ReturnReceipt OFF or ON Can only be used with LabelType Default or DestinationConfirm. Not supported for International Mail.
You must affix ad completed Return Receipt (USPS Form 3811) to the mail piece, and take it to a USPS retail counter.  
ElectronicReturnReceipt OFF or ON Same restrictions as ReturnReceipt.
To receive Electronic Return Receipt delivery information, you must have your own Mailer ID assigned from the USPS and have it applied to your Endicia account. You can then obtain this information from the USPS data center.
A physical form is not required. The equivalent information will be returned electronically.
Endicia does not receive or supply this information.
AdultSignature OFF or ON Requires the signature of someone 21 years of age or older at the receipient’s address
AdultSignatureRestrictedDelivery OFF or ON Requires the the addressee named in the <ToName> element be 21 years of age or older. If the specified individual is not 21 or over, the mailpiece will be returned to the sender.
AMDelivery OFF or ON AMDelivery service for Priority Mail Express is requested

CostCenter Numeric
(8 Characters)
Cost-center code for accounting purposes. Note: This element serves the same purpose as the following CostCenterAlphaNumeric element. Use this element if the cost center values are numeric. Do not use both these elements together. 
Value
CODAmount Currency COD amount to collect. Required if COD is requested for the mailpiece.
RegisteredMailValue Currency The USPS allows up to $50,000 to be added.
Description String
(50 Characters)
Description of the item shipped. Shown in Endicia.com reports.
IntegratedFormType Deprecated
CustomsFormType Deprecated
CustomsFormImageFormat Deprecated
CustomsFormImageResolution Deprecated
OriginCountry String
(2 Characters)
ISO country code for the country of origin used for manufacturing shipped goods. Required for international mail classes.
ContentsType Deprecated
ContentsExplanation Deprecated
NonDeliveryOption Deprecated
ReferenceID String
(50 Characters)
A reference value for your logs.
ReferenceID2 String
(50 Characters)
A reference value for your logs.
ReferenceID3 String
(50 Characters)
A reference value for your logs.
ReferenceID4 String
(50 Characters)
A reference value for your logs.
PartnerCustomerID String
(120 Characters)
A unique identifier for the Partner's end-user printing the label.
This element is only stored in our database for Shared PES accounts.
PartnerTransactionID String
(25 Characters)
A unique identifier for the Partner's end-user's transaction. Not stored in our database.
BpodClientDunsNumber Numeric
(9 Digits)
Mailer ID of the Partner assigned by USPS. Allows the Partner to receive Electronic Return Receipt information from USPS in an extract file uniquely generated for them, provided they have established themselves with USPS as a Bulk Proof of Delivery Client.
RubberStamp1 String
(50 Characters)
User-supplied text to print on the label. See Rubber Stamps.
RubberStamp2 String
(50 Characters)
User-supplied text to print on the label. See Rubber Stamps.
RubberStamp3 String
(50 Characters)
User-supplied text to print on the label. See Rubber Stamps.
EntryFacility
<EntryFacilities> Datatype DNDC
DDU
DSCF
Other
Postal facility where the mail is entered (DefaultOther. If this element is not set to Other, the ZIP Code of this facility must be specified in POZipCode.
POZipCode String
(5 Characters)
ZIP Code of Post Office or collection box where item is mailed. May be different than FromPostalCode. Used for determining the zone and calculating the postage price. Required when EntryFacility is not set to Other. The value of this element must contain the ZIP Code of the postal facility specified in EntryFacility.
ShipDate Date
(MM/DD/YYYY)
Date mailpiece is shipped. Required for Required for Priority Mail Express Sunday or Holiday Delivery Service. Ignored for other mail classes.
ShipTime Time
(HH:MM AM or HH:MM PM)
Time mailpiece is shipped. Applies only to Priority Mail Express Sunday and Holiday Delivery Service. Ignored for other mail classes. If this element is not supplied, it defaults to 12:01 AM.
CustomsInfo <CustomsInfo> Object Customs Declaration, required when using integrated labels.
Show <CustomsInfo> Object
Element Type/Value Description
ContentsType
ContentsTypes Documents
Gift
Merchandise
Other
ReturnedGoods
Sample
HumanitarianDonation
DangerousGoods
Category of the customs items. Value of ReturnedGoods is not available for labels using Form 2976.
ContentsExplanation String
(25 Characters)
Explanation of the customs items. Required if ContentsType is Other.
RestrictionType
RestrictionTypes none
Other
Quarantine
SanitaryPhytosanitaryInspection
Restricted categories (Default none)
RestrictionComments Deprecated
SendersCustomsReference String
(14 Characters)
Sender's customs reference.
ImportersCustomsReference String
(40 Characters)
Importer's customs reference.
LicenseNumber String
(16 Characters)
License Number
CertificateNumber String
(12 Characters)
Certificate Number
InvoiceNumber String
(15 Characters)
Invoice Number
NonDeliveryOption Abandon OR Return Non-delivery instructions, default Return.
InsuredNumber String
(13 Characters)
Deprecated
EelPfc String
(35 Characters)
Exemption or Exclusion Legend (EEL) or a Proof of Filing Citation (PFC). Required for shipments to an international destination or to an overseas U.S. Territory. Enter the Automated Export System (AES) or Internal Transaction Number (ITN) in this element, if required. See USPS Manual for details.
CustomsItems Array of <CustomsItem> Objects Must contain at least 1 but no more than 999 CustomsItem nodes.
Show <CustomsItem> Object
Element Type/Value Description
Description String
(50 Characters)
Description of the customs item.
Quantity Numeric
(3 Digits)
Quantity of the customs item. Must be greater than zero.
Weight Double
(4 Digits with 2 Decimals, ex. 9999.99)
Weight of the customs item. The total must be less than or equal to the value entered in the WeightOz element.
Value Double
(5 Digits with 2 Decimals, ex. 99999.99)
Value of the customs item. Must be greater than zero.
HSTariffNumber Double
(10 Digits)
6-digit or 10-digit HS tariff number.
CountryOfOrigin String
(2 Characters)
Two-character country code of the country where the customs items originated. For a list of valid country codes, see Country Code Table.
RecipientTaxID Deprecated
DDPPayer Deprecated
DDPNonPaymentOption Deprecated
CustomsCertify TRUE or FALSE TRUE means the customs information is certified to be correct and the CustomsSigner name is recommended.
CustomsSigner String
(47 Characters)
Name of person certifying that the customs information is correct. This name prints on the customs form in place of a signature if CustomsCertify is TRUE. Required if CustomsCertify is TRUE.
HfpEmailAddress String
(64 Characters)
Email address of the addressee. An email address or SMS number is required if Service HoldForPickup is selected.
HfpSMS String
(10 Characters)
SMS phone number of the addressee. An email address or SMS number is required if Service HoldForPickup is selected.
HfpFacilityID String
(50 Characters)
Destination Facility ID
MRSPermitNo Deprecated
MRSPermitCityStateZIP Deprecated
MRSPermitFirm Deprecated
MRSPermitStreet Deprecated
MRSRMANumber Deprecated
OpenAndDistributeFacilityType
<FacilityTypes> Datatype SCF
DDU
NDC
ADC
ASF
NDC
Specifies open and distribute facility.
OpenAndDistributeFacilityName String
(50 Characters)
Required when OpenAndDistribute FacilityType = ‘DDU’
OpenAndDistributeTray TRUE or FALSE Default Enclosed mail must be placed in a tray if the total weight is less than 5 pounds. CPP rate qualification is required for trays.
OpenAndDistributeMailClassEnclosed
<MailClassEnclosed> Datatype Marketing Mail Letters
Marketing Mail Flats
Marketing Mail Parcels
Marketing Mail Mix
Other
Mailpieces enclosed
OpenAndDistributeMailClassOther String
(50 Characters)
Required when OpenAndDistribute MailClassEnclosed = ‘Other’
GXGFedexTrackingNumber Deprecated
GXGUSPSTrackingNumber Deprecated
PrintConsolidatorLabel TRUE or FALSE Print Consolidator "no-postage" Label (defaults false).
ResponseOptions Node Optional XML elements to include in the PostageRateResponse.
PostagePrice TRUE or FALSE TRUE means the response contains the PostagePrice node.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.
CustomsSendersCopy TRUE or FALSE Default Sender’s copy is an additional copy of the integrated customs form. It is NOT to be affixed on the package. This extra copy will print if value is set to TRUE. Note: the default value will be changed to FALSE starting in Jan 2017.
NoDate TRUE or FALSE Postmark date to be printed on the label (Default). Postmark date to be suppressed on the label. NoDate must be enabled for your account. An error will be returned otherwise.
MerchantID Deprecated
PrintScanBasedPaymentLabel TRUE or FALSE Print Endicia Pay-On-Use Returns (EPR) or Scan-Based Payment return label. The Sender’s and Recipient’s address will be swapped when printing. Do not print Endicia Pay-On-Use Returns (EPR) label.(Default)
SpecialContents
<SpecialContents> Datatype CrematedRemains
Fragile
Hazmat
Live Animals
Perishable
Special contents requiring special handling or surcharge.
eVSOptions eVSOptions node
COD3816 <COD3816> node Object enclosing the COD elements and options.
Show <COD3816> Object
Element Type/Value Description
AS3816 FALSE or TRUE Specifies 4-part (default) form or 2-part AS3816 form.
USPSCA String
(15 Characters)
USPS Corporate Account Number. Required for Priority Mail Express Return.
PMExpressReturn FALSE or TRUE COD to be returned by Express Mail. A USPS Corporate Account number must be included (<USPSCA>, above). False by default.
OptionalEndorsement String
(50 Characters)
Optional endorsement String on the Form
ReturnName String
(50 Characters)
Return Addressee’s name
ReturnCompany String
(50 Characters)
Return Addressee’s Company
ReturnAddress1 String
(50 Characters)
Return Addressee’s Address Line 1
ReturnAddress2 String
(50 Characters)
Return Addressee’s Address Line 2
ReturnCity String
(50 Characters)
Return Addressee’s Address City
ReturnPostalCode String
(50 Characters)
Return Addressee’s Address Postal Code
ReturnState String
(50 Characters)
Return Addressee’s Address State
EmailMiscNotes String
(5000 Characters)
When ToEMail contains a value, and the function is enabled for your account, Label Server will send a notification to the recipient with the tracking number.
DeliveryTimeDays
TRUE or FALSE Return Delivery time in days for Priority and Priority Mail Express. False (Default) will not include delivery days in the response.
EstimatedDeliveryDate TRUE or FALSE Include Estimated delivery date in the response Do not include Estimated delivery date in the response Default is FALSE Note: Applies only to Priority and Priority Mail Express. This element is dependent on DeliveryTimeDays. EstimatedDeliveryDate is populated in the response when both EstimatedDeliveryDate and DeliveryTimeDays are TRUE, and when ResponseOptions PostagePrice=”TRUE”.
AncillaryServiceEndorsement Deprecated
InsuredValue Currency Enter the dollar amount of insurance.
FromName String
(47 Characters)
Sender's name. Either FromName or FromCompany must contain a value. For customs forms, this element must contain at least two words.
FromCompany String
(47 Characters)
Sender's company name Either FromName or FromCompany must contain a value.
ReturnAddress1 String
(47 Characters)
First delivery address line of sender
ReturnAddress2 String
(47 Characters)
Second delivery address line of sender
ReturnAddress3 String
(47 Characters)
Third delivery address line of sender. Do not use when label type is Domestic or International and a label subtype value is supplied.
ReturnAddress4 String
(47 Characters)
Fourth delivery address line of sender. Do not use when label type is Domestic or International and a label subtype value is supplied.
FromCity String
(50 Characters)
Sender's city Allowed characters: A-Z, a-z, hyphen, period, space
FromState String
(25 Characters)
Sender's state or province. If ValidateAddress is FALSE, this element must contain a valid two-character state code.
FromCountryCode String
(2 Characters)
LIMITED USE. For international returns from countries other than the US. Currently supported for France (FR) only.
FromPostalCode String
(10 Characters)
Sender’s postal code. The format is either ZIP5 only or ZIP+4 for US addresses.
FromZIP4 String
(4 Characters)
+4 add-on for US addresses. Ignored if FromPostalCode contains the ZIP4 value.
FromCountry String
(50 Characters)
Sender's country. This value should be left blank for USA addresses.
FromPhone String
(10 Characters)
Phone number of sender (required for Priority Mail Express and international mail)

10 digits required (including area code) with no punctuation.
Use format: 2125551234
FromEMail String
(64 Characters)
Email address of sender.
ToName String
(47 Characters)
Recipient’s name For Priority Mail Express and international mail: Either ToName or ToCompany must contain a value.
ToCompany String
(47 Characters)
Recipient’s company name For Priority Mail Express and international mail: Either ToName or ToCompany must contain a value.
ToAddress1 String
(47 Characters)
First delivery address line of recipient

A value is optional only when ToCompany contains a value.

Priority Mail Express labels are limited to four lines in the destination address for all label sizes.

4 × 5 and 4 × 4.5 labels are limited to five lines in the destination address.
ToAddress2 String
(47 Characters)
Second delivery address line of recipient
ToAddress3 String
(47 Characters)
Third delivery address line of recipient. Do not use with label type of Domestic.
ToAddress4 String
(47 Characters)
Fourth delivery address line of recipient. Do not use with label type Domestic.
ToCity String
(50 Characters)
Recipient’s city For domestic mail, allowed characters are: A-Z a-z hyphen period space
ToState String
(2 or 25 Characters)
Recipient’s state or province. If ValidateAddress is FALSE domestic mail, this element must contain a valid 2-character state code. Required for domestic mail, optional for international mail.
ToPostalCode String
(5 or 15 Characters)
Recipient’s postal code.

For domestic mail, the format is ZIP5 (required). For international mail, up to 15 characters (optional).
ToZIP4 String
(4 Characters)
+4 add-on for US addresses.
ToDeliveryPoint String
(2 Characters)
+2 Delivery Point for US addresses.
ToCountry Deprecated, use ToCountryCode instead.
ToCountryCode String
(2 Characters)
Two-character country code of the recipient’s country. For a table of valid country names, see Country Code Table
Required when label type is International and a label subtype value is supplied.
ToPhone String
(10 or 30 Characters)
Recipient’s phone number.
For domestic mail: 10 digits including area code with no punctuation. For example: 2125551234. If supplied value is not in the correct format, it will be ignored. For international mail, up to 30 digits with no punctuation.
ToEMail String
(64 Characters)
Email address of recipient.
CustomsCountry1 Deprecated
CustomsDescription1 Deprecated
CustomsQuantity1 Deprecated
CustomsValue1 Deprecated
CustomsWeight1 Deprecated
CustomsCountry2 Deprecated
CustomsDescription2 Deprecated
CustomsQuantity2 Deprecated
CustomsValue2 Deprecated
CustomsWeight2 Deprecated
CustomsCountry3 Deprecated
CustomsDescription3 Deprecated
CustomsQuantity3 Deprecated
CustomsValue3 Deprecated
CustomsWeight3 Deprecated
CustomsCountry4 Deprecated
CustomsDescription4 Deprecated
CustomsQuantity4 Deprecated
CustomsValue4 Deprecated
CustomsWeight4 Deprecated
CustomsCountry5 Deprecated
CustomsDescription5 Deprecated
CustomsQuantity5 Deprecated
CustomsValue5 Deprecated
CustomsWeight5 Deprecated
EelPfc String
(35 Characters)
Exemption or Exclusion Legend (EEL) or a Proof of Filing Citation (PFC). Required for shipments to an international destination or to an overseas U.S. Territory. Enter the Automated Export System (AES) or Internal Transaction Number (ITN) in this element, if required. See USPS Manual for details.
HfpFacilityName String
(50 Characters)
Destination Facility Name.
HfpFacilityAddress1 String
(50 Characters)
Destination Facility Address.
HfpFacilityCity String
(50 Characters)
Destination Facility City.
HfpFacilityState String
(50 Characters)
Destination Facility State.
HfpFacilityPostalCode String
(25 Characters)
Destination Facility 5-Digit ZIP Code.
HfpFacilityZIP4 String
(5 Characters)
Destination Facility +4.
CostCenterAlphaNumeric String
(50 Characters)
Cost-center code for accounting purposes. Note: This element serves the same purpose as the preceding CostCenter element. Use this element if the cost center values are alphanumeric. Do not use both these elements together. 
ToCarrierRoute Deprecated
HazardousMaterial Deprecated
FromCountryCode String
(2 Characters)
LIMITED USE. For international returns from countries other than the US. Currently supported for France (FR) only.

ImageFormats

Mailpiece Dimensions

Required for calculating Commercial Plus Cubic pricing and for Priority Mail mailpieces going to Zones 5-9 that are over 1 cubic foot. All values must be in inches. Length, Width, and Height must contain only a non-zero positive value. When PackageTypeIndicator is Softpack, set Height to 1. For tips on accurately calculating balloon and dimensional weights, see http://pe.usps.com/text/dmm300/123.htm#1219457.

Priority Mail Express Sunday and Holiday Service.

For an additional fee, your Priority Mail Express mailpiece will be delivered on Sundays and Federal holidays. Priority Mail Express Sunday and Holiday delivery service is not available to all destinations. When shipping a mailpiece with the MailClass of PriorityMailExpress and <SundayHolidayDelivery> set to Sunday or Holiday, the Endicia Label Server performs the following steps:

  1. Verifies if the next day or second day after the ShipDate is on a Sunday or a Holiday. If it is not, the Endicia Label Server returns error code 11111.
  2. Retrieves the Priority Mail Express Service Commitments from the USPS servers using the origin and destination ZIP Codes and ShipDate.
    • If no Service Commitments are received for Next Day 12 PM, Next Day 3PM, or 2-Day delivery service, the Endicia Label Server returns error code 11112.
    • If Service Commitments are received for two delivery days only, then the Endicia Label Server returns error code 11113.
    • In case of an error communicating with the USPS servers, the Endicia Label Server can return either error code 11102, ExpressMailAPIError, or error code 11110.
  3. Verifies the day when the Service Commitment occurs. If it does not occur on a Sunday or a Holiday, the Endicia Label Server returns error code 11113.
  4. Cycles through all locations for the Service Commitments to determine if at least one location accepts Priority Mail Express shipments past the supplied ShipTime. If all cut-off times have expired, the Endicia Label Server returns error code 11114. ShipTime is optional; if ShipTime is not supplied, it defaults to 12:01 AM, essentially accepting any location in this step.

For a label or price request, the Endicia Label Server returns the appropriate response with the $12.50 Sunday-Holiday Delivery premium included in the postage. For a label request, if the destination ZIP Code does not deliver Priority Mail Express on Sundays or holidays, the Endicia Label Server returns error code 11115. If you want delivery on Sunday, set <NoWeekendDelivery> to TRUE, and set <SundayHolidayDelivery> to SUNDAY.

Rubber Stamps

A label can contain one or more user-supplied text labels that are called Rubber Stamps. The Endicia Label Server Web Service supports up to three Rubber Stamp fields within a label. Although each Rubber Stamp field can have as many as 50 characters, the actual number of characters that can be printed on the label depends on the content of the Rubber Stamp text. This is true for all labels which are not in EPL2 format because all text is drawn using proportional fonts. Labels in EPL2 format, however, use monospaced fonts. Therefore, the number of characters in the Rubber Stamp fields will be much less than the maximum allowed. For example, a 4×6 default label in EPL2 format can accommodate 26 or fewer characters in each Rubber Stamp field. Note that International labels will not print Rubber Stamp elements.

GetPostageLabel Response

<GetPostageLabel> Response

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>
    <GetPostageLabelResponse xmlns="www.envmgr.com/LabelService">
      <LabelRequestResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <Base64LabelImage>string</Base64LabelImage>
        <Label Name="string">
          <Image PartNumber="int" />
          <Image PartNumber="int" />
        </Label>
        <CustomsForm Name="string">
          <Image PartNumber="int" />
          <Image PartNumber="int" />
        </CustomsForm>
        <PIC>string</PIC>
        <CustomsNumber>string</CustomsNumber>
        <TrackingNumber>string</TrackingNumber>
        <FinalPostage>decimal</FinalPostage>
        <TransactionID>int</TransactionID>
        <TransactionDateTime>string</TransactionDateTime>
        <PostmarkDate>string</PostmarkDate>
        <PostageBalance>decimal</PostageBalance>
        <ReferenceID>string</ReferenceID>
        <CostCenter>int</CostCenter>
        <HfpFacilityID>string</HfpFacilityID>
        <HfpFacilityName>string</HfpFacilityName>
        <HfpFacilityAddress1>string</HfpFacilityAddress1>
        <HfpFacilityCity>string</HfpFacilityCity>
        <HfpFacilityState>string</HfpFacilityState>
        <HfpFacilityPostalCode>string</HfpFacilityPostalCode>
        <HfpFacilityZIP4>string</HfpFacilityZIP4>
        <PostagePrice TotalAmount="decimal">
          <MailClass>string</MailClass>
          <Postage TotalAmount="decimal">
            <MailService>string</MailService>
            <Zone>string</Zone>
            <IntraBMC>string</IntraBMC>
            <Pricing>string</Pricing>
          </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" />
          </Fees>
          <DeliveryTimeDays>string</DeliveryTimeDays>
          <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
          <DdpRate>decimal</DdpRate>
        </PostagePrice>
        <RequesterID>string</RequesterID>
        <ReferenceID2>string</ReferenceID2>
        <ReferenceID3>string</ReferenceID3>
        <ReferenceID4>string</ReferenceID4>
        <CostCenterAlphaNumeric>string</CostCenterAlphaNumeric>
        <Indicium>string</Indicium>
        <BarcodeDisplay>string</BarcodeDisplay>
        <BarcodeNumber>string</BarcodeNumber>
        <Banner>string</Banner>
        <RDC>string</RDC>
        <RoutingNumber>string</RoutingNumber>
        <DeliveryTimeDays>string</DeliveryTimeDays>
        <DHLInboundSortCode>string</DHLInboundSortCode>
        <DHLOutboundSortCode>string</DHLOutboundSortCode>
        <DHLDestMailTerminal>string</DHLDestMailTerminal>
        <DHLMailType>string</DHLMailType>
        <DHLITVersion>string</DHLITVersion>
        <DHLServiceLevel>string</DHLServiceLevel>
        <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>
        <SequenceNumber>string</SequenceNumber>
        <ResellerInformation>
          <AccountId>long</AccountId>
          <DeviceId>string</DeviceId>
          <CustomerEndUserId>int</CustomerEndUserId>
        </ResellerInformation>
        <EstimatedDeliveryDate>string</EstimatedDeliveryDate>
        <SDRValue>string</SDRValue>
      </LabelRequestResponse>
    </GetPostageLabelResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String
(150 Characters)
Error Message
Base64LabelImage Base64 string Image of the label. If the Label node is present, then this element will not exist. See Note Base64 Image Locations.
Label Array of <Image> objects Contains one or more <Image> elements for each part of the label.
Show <Image> Object
Element Type/Value Description
Image Base64 String Part of the label image.
PartNumber Numeric Attribute Partnumber of Image

CustomsForm Array of <Image> objects Contains one or more <Image> elements for each part of the customs form.

Note: The CustomsForm node is retained for backward compatibility only.

Show <Image> Object

Element Type/Value Description
Image Base64 String Part of the label image.
PartNumber Numeric Attribute Partnumber of Image

PIC String Same as TrackingNumber. For domestic mail pieces only.
CustomsNumber String
(13 Characters)
Customs form number.
TrackingNumber String For domestic mail, this value is also copied to the PIC element. For international mail and domestic mail using customs forms, this value is also copied to the CustomsNumber element. Note: With the migration from Planet Code technology to IMb technology for DestinationConfirm services, the TrackingNumber returned can be up to 31 characters long.
FinalPostage Currency Total postage and fees for transaction.
TransactionID Long Unique ID for transaction - corresponds to the piece count for the account used.
TransactionDateTime Datetime
(YYYYMMDDHHMMSS)
Date and time the transaction was created. Expressed in UTC.
PostmarkDate Date
(YYYYMMDD)
Indicates the postmark date.
PostageBalance Currency Remaining postage balance after label is generated, in dollars and cents (mils).
ReferenceID String
(50 Characters)
A reference value for logs.
CostCenter Numeric
(8 Digits)
Cost-center code for accounting purposes.
HfpFacilityID String
(50 Characters)
Destination Facility ID.
HfpFacilityName String
(50 Characters)
Destination Facility Name.
HfpFacilityAddress1 String
(50 Characters)
Destination Facility Address.
HfpFacilityCity String
(50 Characters)
Destination Facility City.
HfpFacilityState String
(50 Characters)
Destination Facility State.
HfpFacilityPostalCode String
(25 Characters)
Destination Facility 5-Digit ZIP Code.
HfpFacilityZIP4 String
(5 Characters)
Destination Facility +4.
PostagePrice <PostagePrice> Postage price for transaction.
Show <PostagePrice> Object

Element Type/Value Description
TotalAmount Currency Attribute of <PostagePrice> defining total amount of postage and fees. This value is also copied to the FinalPostage element.
Postage <Postage> Object Object breakdown of total postage assessed.
Show <Postage> Object

Element Type/Value Description
TotalAmount Currency Total amount of postage.
MailService String
(50 Characters)

Description of MailClass requested. For instance, a PostagePrice object with MailClass PriorityMailInternational will display Priority Mail International for the MailService.
Zone String
(0 (local zone) through 9)

Number of postal rate zones between the sender’s and recipient’s ZIP Codes. Applies only to domestic mail.
IntraNDC true or false Zone is Intra-NDC.
Zone is Inter-NDC.

Applies only to domestic mail.

Pricing
<Pricing> Datatype

Commercial
CommercialBase
CommercialPlus
NSA
Retail

USPS pricing level associated with returned postage estimate.
Fees <Fees> Object Object breakdown of fees associated with postage
Show <Fees> Object
Element Type/Value Description
TotalAmount Currency Total amount of fees.
CertificateOfMailing Currency Certificate of Mailing fee.
For future use.

CertifiedMail Currency Certified Mail fee.
CollectOnDelivery Currency Collect on Delivery (COD) fee.
For future use.

DeliveryConfirmation Currency Delivery Confirmation fee.
ElectronicReturnReceipt Currency Electronic Return Receipt fee.
InsuredMail Currency Insured Mail fee.
RegisteredMail Currency Registered Mail fee.
For future use.

RestrictedDelivery Currency Restricted Delivery fee.
ReturnReceipt Currency Return Receipt fee.
ReturnReceiptForMerchandise Currency Return Receipt for Merchandise fee.
For future use.

SignatureConfirmation Currency Signature Confirmation fee.
SpecialHandling Currency Special Handling fee.
For future use.

AdultSignature Currency Adult Signature fee.
AdultSignatureRestrictedDelivery Currency Adult Signature Restricted Delivery fee.
LiveAnimalSurcharge Currency Live Animal Surcharge fee.
DeliveryTimeDays Numeric (1 Digit) Delivery time in days
EstimatedDeliveryDate Date
(d/m/yyyy)

Estimated delivery date
Note: Applies only to Priority and Priority Mail Express.

AMDelivery Numeric AM Delivery fee for Priority Mail Express packages.
GroupedExtraServices <GroupedExtraServices> Object Container for Extra Services and associated fees.
Show <GroupedExtraServices>Object

Element Type/Value Description
Services SignatureConfirmation;RestrictedDelivery
CertifiedMail;RestrictedDelivery
CertifiedMail;AdultSignature
CertifiedMail;AdultSignatureRestrictedDelivery

Extra services subscribed
FeeAmount Currency Amount for Grouped Service

RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the partner making the request. Endicia assigns this ID.
ReferenceID2 String
(50 Characters)
A reference value for your logs.
ReferenceID3 String
(50 Characters)
A reference value for your logs.
ReferenceID4 String
(50 Characters)
A reference value for your logs.
CostCenterAlphaNumeric String
(50 Characters)
Cost-center code for accounting purposes.

Note: This element serves the same purpose as the preceding CostCenter element. Use this element if the cost center values are alphanumeric.Do not use both these elements together.

Indicium

Deprecated
BarcodeDisplay

Deprecated
BarcodeNumber

Deprecated
Banner

Deprecated
RDC

Deprecated
RoutingNumber

Deprecated
DeliveryTimeDays Numeric
(1 Digit)
Delivery time in days
DHLInboundSortCode

Deprecated
DHLOutboundSortCode

Deprecated
DHLDestMailTerminal

Deprecated
DHLMailType

Deprecated
DHLITVersion

Deprecated
DHLServiceLevel

Deprecated
PriorityMailExpressCommitments

Deprecated
SequenceNumber

Deprecated
ResellerInformation

Deprecated
EstimatedDeliveryDate Date
(d/m/yyyy)
Estimated delivery date Note: Applies only to Priority and Priority Mail Express.
SDRValue Deprecated

Base64 Image Locations

Depending on your Label Request options, the Base64 images can be contained in different elements.

LabelType or MailClass Location
Default: any domestic MailClass Base64LabelImage
Domestic: any domestic MailClass <Label>; Object
International: any international MailClass <Label>; Object
Default to military or territories/possessions w/<CustomsFormType> Base64LabelImage AND <CustomsForm> Object
International w/<CustomsFormType> ` Object

GetPackagePickUp

GetPackagePickup is a part of a larger suite of functions that are designed to provide full service for all pickup scheduling. The four funtions are: GetPackagePickup, GetPackagePickupAvailability, GetPackagePickupChange, and GetPackagePickupCancel.

GetPackagePickup

GetPackagePickup Request

<GetPackagePickup> Request

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

<?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>
    <GetPackagePickup xmlns="www.envmgr.com/LabelService">
      <PackagePickupRequest Test="string">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
        </PhysicalPickupAddress>
        <ExpressMailCount>int</ExpressMailCount>
        <PriorityMailCount>int</PriorityMailCount>
        <FirstClassPackageCount>int</FirstClassPackageCount>
        <ReturnsCount>int</ReturnsCount>
        <InternationalCount>int</InternationalCount>
        <OtherPackagesCount>int</OtherPackagesCount>
        <EstimatedWeightLb>double</EstimatedWeightLb>
        <PackageLocation>string</PackageLocation>
        <SpecialInstructions>string</SpecialInstructions>
        <CostCenter>string</CostCenter>
      </PackagePickupRequest>
    </GetPackagePickup>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Test YES or NO Set to YES only if testing on production servers.
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

UseAddressOnFile YES or NO If NO, PhysicalPickupAddress node is required.
PhysicalPickupAddress <PhysicalPickupAddress> Object Location where parcels are to be picked up.
Show <PhysicalPickupAddress> Object

Element Type/Value Description
FirstName String
(50 Characters)
 
LastName String
(50 Characters)
 
CompanyName String
(50 Characters)
Optional, except if needed to uniquely identify an address.  Some companies that have their own ZIP Codes require the use of company name to properly identify their address.
Address String
(50 Characters)
 
City String
(50 Characters)
 
State String
(2 Characters)
 
Zip5 String
(5 Characters)
 
Zip4 String
(4 Characters)
 
Phone String
(10 Characters)
Enter numbers only, with no punctuation or spaces.

ExpressMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
PriorityMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
FirstClassMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
ReturnsCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
InternationalCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
OtherPackagesCount Numeric
(3 Digits)

All others (Parcel Select Ground, etc.)
EstimatedWeightLb Double Cannot exceed what would be the maximum weight for the number of packages. Example: You have 3 packages and enter 300 lbs. Because the absolute maximum that a USPS package can weigh is 70 lbs, an error will be returned.
PackageLocation

<PackageLocation> Datatype Front Door
Back Door
Side Door
Knock on Door/Ring Bell
Mailroom
Office
Reception
In/At Mailbox
Other

Location of parcels - choose one.
SpecialInstructions String
(255 Characters)

Special instructions for pickup—Ring Bell, SCAN Form in envelope, and so on.

GetPackagePickup Response

<GetPackagePickup> Response

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>
    <GetPackagePickupResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <ConfirmationNumber>string</ConfirmationNumber>
        <PackagePickup>
          <DayOfWeek>string</DayOfWeek>
          <Date>string</Date>
          <CarrierRoute>string</CarrierRoute>
        </PackagePickup>
      </PackagePickupResponse>
    </GetPackagePickupResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
ConfirmationNumber String
(50 Characters)
Confirmation number
PackagePickup <PackagePickup> Object Container object for date and route of package pickup.
Show <PackagePickup> Object
Element Type/Value Description
DayOfWeek
<PickupDayofWeek> Datatype Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Day of week, Monday-Saturday that package will be picked up.
Date Date
(mm/dd/yyyy)
Date in month, date, year format.
CarrierRoute C, H, or R City, Highway, or Rural

GetPackagePickupAvailability

GetPackagePickupAvailability Request

<GetPackagePickupAvailability> Request

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

<?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>
    <GetPackagePickupAvailability xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
        </PhysicalPickupAddress>
      </PackagePickupAvailabilityRequest>
    </GetPackagePickupAvailability>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

UseAddressOnFile YES or NO If NO, PhysicalPickupAddress node is required.
PhysicalPickupAddress <PhysicalPickupAddress> Object Location where parcels are to be picked up.
Show <PhysicalPickupAddress> Object

Element Type/Value Description
FirstName String
(50 Characters)
 
LastName String
(50 Characters)
 
CompanyName String
(50 Characters)
Optional, except if needed to uniquely identify an address.  Some companies that have their own ZIP Codes require the use of company name to properly identify their address.
Address String
(50 Characters)
 
City String
(50 Characters)
 
State String
(2 Characters)
 
Zip5 String
(5 Characters)
 
Zip4 String
(4 Characters)
 
Phone String
(10 Characters)
Enter numbers only, with no punctuation or spaces.

GetPackagePickupAvailability Response

<GetPackagePickupAvailability> Response

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>
    <GetPackagePickupAvailabilityResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupAvailabilityResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <PackagePickup>
          <DayOfWeek>string</DayOfWeek>
          <Date>string</Date>
          <CarrierRoute>string</CarrierRoute>
        </PackagePickup>
      </PackagePickupAvailabilityResponse>
    </GetPackagePickupAvailabilityResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
PackagePickup <PackagePickup> Object Container object for date and route of package pickup.
Show <PackagePickup> Object
Element Type/Value Description
DayOfWeek
<PickupDayofWeek> Datatype Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Day of week, Monday-Saturday that package will be picked up.
Date Date
(mm/dd/yyyy)
Date in month, date, year format.
CarrierRoute C, H, or R City, Highway, or Rural

GetPackagePickupChange

GetPackagePickupChange Request

<GetPackagePickupChange> Request

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

<?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>
    <GetPackagePickupChange xmlns="www.envmgr.com/LabelService">
      <PackagePickupChangeRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
        </CertifiedIntermediary>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Phone>string</Phone>
        </PhysicalPickupAddress>
        <ExpressMailCount>int</ExpressMailCount>
        <PriorityMailCount>int</PriorityMailCount>
        <ReturnsCount>int</ReturnsCount>
        <InternationalCount>int</InternationalCount>
        <OtherPackagesCount>int</OtherPackagesCount>
        <EstimatedWeightLb>double</EstimatedWeightLb>
        <PackageLocation>string</PackageLocation>
        <ConfirmationNumber>string</ConfirmationNumber>
      </PackagePickupChangeRequest>
    </GetPackagePickupChange>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Test YES or NO Set to YES only if testing on production servers.
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

UseAddressOnFile YES or NO If NO, PhysicalPickupAddress node is required.
PhysicalPickupAddress <PhysicalPickupAddress> Object Location where parcels are to be picked up.
Show <PhysicalPickupAddress> Object

Element Type/Value Description
FirstName String
(50 Characters)
 
LastName String
(50 Characters)
 
CompanyName String
(50 Characters)
Optional, except if needed to uniquely identify an address.  Some companies that have their own ZIP Codes require the use of company name to properly identify their address.
Address String
(50 Characters)
 
City String
(50 Characters)
 
State String
(2 Characters)
 
Zip5 String
(5 Characters)
 
Zip4 String
(4 Characters)
 
Phone String
(10 Characters)
Enter numbers only, with no punctuation or spaces.

ExpressMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
PriorityMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
FirstClassMailCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
ReturnsCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
InternationalCount Numeric
(3 Digits)

At least one package for Express Mail, Priority Mail, or First-Class Pacage Service. Must specify Returns or International.
OtherPackagesCount Numeric
(3 Digits)

All others (Parcel Select Ground, etc.)
EstimatedWeightLb Double Cannot exceed what would be the maximum weight for the number of packages. Example: You have 3 packages and enter 300 lbs. Because the absolute maximum that a USPS package can weigh is 70 lbs, an error will be returned.
PackageLocation

<PackageLocation> Datatype Front Door
Back Door
Side Door
Knock on Door/Ring Bell
Mailroom
Office
Reception
In/At Mailbox
Other

Location of parcels - choose one.
SpecialInstructions String
(255 Characters)

Special instructions for pickup—Ring Bell, SCAN Form in envelope, and so on.
ConfirmationNumber String
(50 Characters)

Confirmation number

GetPackagePickupChange Response

<GetPackagePickupChange> Response

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>
    <GetPackagePickupChangeResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupChangeResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <ConfirmationNumber>string</ConfirmationNumber>
        <PackagePickup>
          <DayOfWeek>string</DayOfWeek>
          <Date>string</Date>
          <CarrierRoute>string</CarrierRoute>
        </PackagePickup>
      </PackagePickupChangeResponse>
    </GetPackagePickupChangeResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
ConfirmationNumber String
(50 Characters)
Confirmation number
PackagePickup <PackagePickup> Object Container object for date and route of package pickup.
Show <PackagePickup> Object
Element Type/Value Description
DayOfWeek
<PickupDayofWeek> Datatype Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Day of week, Monday-Saturday that package will be picked up.
Date Date
(mm/dd/yyyy)
Date in month, date, year format.
CarrierRoute C, H, or R City, Highway, or Rural

GetPackagePickupCancel

GetPackagePickupCancel Request

<GetPackagePickupCancel> Request

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

<?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>
    <GetPackagePickupCancel xmlns="www.envmgr.com/LabelService">
      <PackagePickupCancelRequest Test="string">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <UseAddressOnFile>string</UseAddressOnFile>
        <PhysicalPickupAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
        </PhysicalPickupAddress>
        <ConfirmationNumber>string</ConfirmationNumber>
      </PackagePickupCancelRequest>
    </GetPackagePickupCancel>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Test YES or NO Set to YES only if testing on production servers.
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

UseAddressOnFile YES or NO If NO, PhysicalPickupAddress node is required.
PhysicalPickupAddress <PhysicalPickupAddress> Object Location where parcels are to be picked up.
Show <PhysicalPickupAddress> Object

Element Type/Value Description
FirstName String
(50 Characters)
 
LastName String
(50 Characters)
 
CompanyName String
(50 Characters)
Optional, except if needed to uniquely identify an address.  Some companies that have their own ZIP Codes require the use of company name to properly identify their address.
Address String
(50 Characters)
 
City String
(50 Characters)
 
State String
(2 Characters)
 
Zip5 String
(5 Characters)
 
Zip4 String
(4 Characters)
 
Phone String
(10 Characters)
Enter numbers only, with no punctuation or spaces.

ConfirmationNumber String
(50 Characters)

Confirmation number

GetPackagePickupCancel Response

<GetPackagePickupCancel> Response

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>
    <GetPackagePickupCancelResponse xmlns="www.envmgr.com/LabelService">
      <PackagePickupCancelResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <ConfirmationNumber>string</ConfirmationNumber>
        <PickupStatus>string</PickupStatus>
      </PackagePickupCancelResponse>
    </GetPackagePickupCancelResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
PickupStatus String Status of the Pickup Request

GetSCAN

The Shipment Confirmation Acceptance Notice (SCAN) associates all trackable items in a single form containing a barcode which the carrier scans when your packages are picked up. When tracking numbers are uploaded into the postal system that evening, all packages that are on the form will receive an Acceptance event.

The SCAN Request uses the <PostmarkDate> to determine eligibility for inclusion on a SCAN Request. After 9:00 PM PT (Midnight ET) on the <PostmarkDate>, the tracking number will no longer be eligible to be included in a SCAN Request.

Any tracking numbers that the carrier has previously accepted or are already included in another SCAN Request will not be included, and that once the <PostmarkDate> is past, the tracking number is no longer eligible for SCAN.

GetSCAN Request

<GetSCAN> Request

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

<?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>
    <GetSCAN xmlns="www.envmgr.com/LabelService">
      <GetSCANRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <GetSCANRequestParameters ImageResolution="string"
                                  ImageFormat="string"
                                  SubmissionID="string"
                                  CostCenter="string"
                                  FormType="string"
                                  ReferenceID="string"
                                  SearchZip="string">
          <FromName>string</FromName>
          <FromCompany>string</FromCompany>
          <FromAddress>string</FromAddress>
          <FromCity>string</FromCity>
          <FromState>string</FromState>
          <FromZip>string</FromZip>
        </GetSCANRequestParameters>
        <PicNumbers>
          <PicNumber>string</PicNumber>
          <PicNumber>string</PicNumber>
        </PicNumbers>
        <TransactionIds>
          <TransactionId>string</TransactionId>
          <TransactionId>string</TransactionId>
        </TransactionIds>
        <PieceNumbers>
          <PieceNumber>string</PieceNumber>
          <PieceNumber>string</PieceNumber>
        </PieceNumbers>
        <ManifestType>All or GlobalPost or None or USPS</ManifestType>
        <NumberOfContainerLabels>int</NumberOfContainerLabels>
      </GetSCANRequest>
    </GetSCAN>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

GetScanRequestParameters <GetScanRequestParameters> Object Set parameters for SCAN form requests
Show <GetScanRequestParameters> Attributes

ImageFormat PDF, GIF, PNG or JPG Format of the image returned in base64 format (PDF is default).
ImageResolution 96, 150 or 300  
SubmissionID String
(25 Characters)

Submission ID of the form. Enter the SubmissionID of a previously generated SCAN Form to obtain a reprint.
CostCenter String
(15 Characters)

Filter: Use to include all pieces with the value contained in the CostCenter element of the Label Request.
ReferenceID String
(50 Characters)

Filter: Use to include all pieces with the value contained in the ReferenceID element of the Label Request.
SearchZip String
(5 Characters)

Filter: Use to include all pieces with the ZIP Code contained in the FromPostalCode element of the Label Request.
FormType 5630OR 3152 USPS PS-5630 SCAN form (default) or USPS PS-3152 SCAN form (for Open and Distribute services)

FromName String
(50 Characters)

Name on the form
FromAddress String
(100 Characters)

Address on the form
FromCity String
(50 Characters)

City on the form
FromState String
(2 Characters)

State abbreviation on the form
FromZip String
(5 Characters)

ZIP Code on the form
PicNumbers Array of 25 Digit PicNumber Package PIC or CustomsNumber
PieceNumbers Array of 25 Digit PieceNumber Corresponds to the TransactionID from the Label Request Response.

GetSCAN Notes

GetSCAN Response

<GetSCAN> Response

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>
    <GetSCANResponse xmlns="www.envmgr.com/LabelService">
      <GetSCANResponse>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <SubmissionID>string</SubmissionID>
        <SCANForm>string</SCANForm>
        <SubmissionIdOld>string</SubmissionIdOld>
        <ScanFormOld>string</ScanFormOld>
        <ExcludedItems>
          <Item>string</Item>
          <Item>string</Item>
        </ExcludedItems>
        <EndOfDayManifest>
          <ManifestType>All or GlobalPost or None or USPS</ManifestType>
          <PickUpCarrier>string</PickUpCarrier>
          <ManifestID>int</ManifestID>
          <ManifestUrl>string</ManifestUrl>
          <ContainerLabels>
            <ContainerLabel xsi:nil="true" />
            <ContainerLabel xsi:nil="true" />
          </ContainerLabels>
        </EndOfDayManifest>
      </GetSCANResponse>
    </GetSCANResponse>
  </soap:Body>
</soap:Envelope>

Element Type/Value Description
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
SubmissionID Numeric Submission ID of the SCAN Form.
Excluded Items Array of PicNumber or PieceNumber Exclusions
(200 Characters per object)
PicNumber or PieceNumber and associated SubmissionID. Each Item will contain the following text: “{PicNumber} or {PieceNumber} associated with SCAN form Submission ID: {SubmissionID}”

StatusRequest

To track a package, use the StatusRequest web method of the Endicia Label Server Web Service.

For further information, please see Track a Package in the quick start guide above.

StatusRequest Request

<StatusRequest> Request

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

<?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>
    <StatusRequest xmlns="www.envmgr.com/LabelService">
      <PackageStatusRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <RequestOptions CostCenter="string"
                        ReferenceID="string"
                        PackageStatus="CURRENT or COMPLETE"
                        StartingTransactionID="string" />
        <PicNumbers>
          <PicNumber>string</PicNumber>
          <PicNumber>string</PicNumber>
        </PicNumbers>
        <PieceNumbers>
          <PieceNumber>string</PieceNumber>
          <PieceNumber>string</PieceNumber>
        </PieceNumbers>
        <TransactionIds>
          <TransactionId>string</TransactionId>
          <TransactionId>string</TransactionId>
        </TransactionIds>
        <ReferenceIds>
          <ReferenceId>string</ReferenceId>
          <ReferenceId>string</ReferenceId>
        </ReferenceIds>
      </PackageStatusRequest>
    </StatusRequest>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

RequestOptions <RequestOptions> Object Sets filtering options for tracing request.
Show <RequestOptions> Object

Element Type/Value Description
CostCenter String CostCenter or CostCenterAlphanumeric used in the Label Request.
ReferenceID String ReferenceID used in the Label Request.
PackageStatus CURRENT or COMPLETE Specify to retrieve exclusively the current or all package statuses. See CompleteDataSet for more information.
StartingTransactionID String Specify the starting TransactionID in your request range.

PicNumbers Array of 31 Digit PicNumber Package PIC or CustomsNumber
TransactionIds Array of 25 Digit TransactionID Corresponds to the TransactionID from the Label Request Response.
PieceNumbers Array of 25 Digit PieceNumber Corresponds to the TransactionID from the Label Request Response.

Notes

StatusRequest Response

<StatusRequest> Response

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>
    <StatusRequestResponse xmlns="www.envmgr.com/LabelService">
      <PackageStatusResponse StartingTransactionID="string"
                             EndingTransactionID="string"
                             CompleteDataSet="boolean">
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <PackageStatus>
          <StatusResponse>
            <PicNumber>string</PicNumber>
            <PieceId>string</PieceId>
            <TransactionID>string</TransactionID>
            <PackageStatusEventList xsi:nil="true" />
          </StatusResponse>
          <StatusResponse>
            ...
          </StatusResponse>
        </PackageStatus>
      </PackageStatusResponse>
    </StatusRequestResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
StartingTransactionID String The first TransactionID returned.
EndingTransactionID String The last TransactionID returned.
CompleteDataSet T or F Specifies whether all data is returned, or only the last status item. See CompleteDataSet for more information.
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
PackageStatus StatusResponse Container Lists all tracking data available for request.
Show StatusResponse
Element Type/Value Description
PicNumber String Package PIC or CustomsNumber
PieceID String Corresponds to the TransactionID from the Label Request Response.
TransactionId String Corresponds to the TransactionID from the Label Request Response.
PackageStatusEventList <StatusEvent> Container Status Event List of the package
Show <StatusEvent> Object
Element Type/Value Description
StatusCode String See StatusCode Definitions
StatusDescription String Status Descriptions returned as string
EventDateTime DateTime
(d/m/yyyy hhr:min:sec AM/PM)
Date and Time are local to city and state of event.
TrackingSummary String Returned as a text string.
TrackingResults Array of <TrackingResult> Returned only when PackageStatus Attribute in Request is COMPLETE.
Show <TrackingResult> Object
Element Type/Value Description
Status String Each status event, in descending order, will be returned in this node as a text string.

CompleteDataSet

When the CompleteDataSet attribute is false, the EndingTransactionID will indicate the last TransactionID in the response.

In order to retrieve the complete data set, resubmit the StatusRequest using the same parameters, adding the StartingTransactionID attribute containing the value returned in the EndingTransactionID +1 (ex. EndingTransactionID=”2100” in Response – enter StartingTransactionID=”2101” in subsequent Request. Continue this process until CompleteDataSet returns true.

GetRefund

To submit a refund request, use the GetRefund web method of the Endicia Label Server Web Service.

If you are developing software for use by multiple customers and thus will be maintaining multiple accounts, this is a particularly useful method that allows your customers to submit refund requests more efficiently.

For further information, please see Cancel Label in the quick start guide above.

GetRefund Request

<GetRefund> Request

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

<?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>
    <GetRefund xmlns="www.envmgr.com/LabelService">
      <RefundRequest>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <PicNumbers>
          <PicNumber>string</PicNumber>
          <PicNumber>string</PicNumber>
        </PicNumbers>
        <TransactionIds>
          <TransactionId>long</TransactionId>
          <TransactionId>long</TransactionId>
        </TransactionIds>
        <PieceNumbers>
          <PieceNumber>int</PieceNumber>
          <PieceNumber>int</PieceNumber>
        </PieceNumbers>
      </RefundRequest>
    </GetRefund>
  </soap:Body>
</soap:Envelope>

Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

PicNumbers Array of 31 Digit PicNumber Package PIC or CustomsNumber
TransactionIds Array of 25 Digit TransactionID Corresponds to the TransactionID from the Label Request Response.
PieceNumbers Array of 25 Digit PieceNumber Corresponds to the TransactionID from the Label Request Response.

GetRefund Response

<GetRefund> Response

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>
    <GetRefundResponse xmlns="www.envmgr.com/LabelService">
      <RefundResponse>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <Refund PicNumber="string" TransactionId="long" PieceNumber="int">
          <RefundStatus>Approved or DeniedInvalid</RefundStatus>
          <RefundStatusMessage>string</RefundStatusMessage>
        </Refund>
        <Refund PicNumber="string" TransactionId="long" PieceNumber="int">
          <RefundStatus>Approved or DeniedInvalid</RefundStatus>
          <RefundStatusMessage>string</RefundStatusMessage>
        </Refund>
        <FormId>string</FormId>
        <BatchId>string</BatchId>
      </RefundResponse>
    </GetRefundResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
ErrorMessage String
(150 Characters)
Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
Refund Array of Refund objects Container for all refund information
Show Refund object
Element Type/Value Description
PicNumber String
(31 Characters)
Package PIC number
TransactionID Long Package transaction number
PieceNumber Numeric Package piece number
RefundStatus Approved> OR DeniedInvalid Describes if request was approved.

FormId String Form Number for Refund Request
BatchId String Batch Number for Refund Request

GetUserSignup

To signup for a new account, use the GetUserSignup web method of the Endicia Label Web Service.

GetUserSignup is required for most Partner integrations and can also be used for managing multiple locations and other relationships where more than one account would be needed.

GetUserSignup allows your customers to sign up for accounts directly through your interface. You can collect all the needed information and submit it through this API. In return, you will get an acknowledgement response back, containing the assigned account number. The account number will also be sent to the customer in an email message.

GetUserSignup Request

<GetUserSignup> Request

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

<?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>
    <GetUserSignUp xmlns="www.envmgr.com/LabelService">
      <UserSignUpRequest TokenRequested="boolean">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <MiddleName>string</MiddleName>
        <Title>string</Title>
        <EmailAddress>string</EmailAddress>
        <PhoneNumber>string</PhoneNumber>
        <PhoneNumberExt>string</PhoneNumberExt>
        <FaxNumber>string</FaxNumber>
        <BillingType>string</BillingType>
        <PartnerID>string</PartnerID>
        <OriginatingIpAddress>string</OriginatingIpAddress>
        <Contracts>
          <ContractId>string</ContractId>
          <ContractId>string</ContractId>
        </Contracts>
        <AccountCredentials>
          <WebPassword>string</WebPassword>
          <TemporaryPassPhrase>string</TemporaryPassPhrase>
          <SecurityQuestion>string</SecurityQuestion>
          <SecurityAnswer>string</SecurityAnswer>
        </AccountCredentials>
        <CreditCard>
          <CreditCardNumber>string</CreditCardNumber>
          <CreditCardType>Visa or
                          Mastercard or
                          AmericanExpress or
                          CarteBlanche or
                          Discover or
                          DinersClub
          </CreditCardType>
          <CreditCardMonth>January or
                           February or
                           March or
                           April or
                           May or
                           June or
                           July or
                           August or
                           September or
                           October or
                           November or
                           December
          </CreditCardMonth>
          <CreditCardYear>int</CreditCardYear>
          <CreditCardAddress>string</CreditCardAddress>
          <CreditCardCity>string</CreditCardCity>
          <CreditCardState>string</CreditCardState>
          <CreditCardZip5>string</CreditCardZip5>
          <CreditCardCVV>string</CreditCardCVV>
          <CreditCardCountryCode>string</CreditCardCountryCode>
        </CreditCard>
        <CheckingAccount>
          <AccountNumber>string</AccountNumber>
          <RoutingNumber>string</RoutingNumber>
        </CheckingAccount>
        <PhysicalAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
        </PhysicalAddress>
        <MailingAddress>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <CompanyName>string</CompanyName>
          <SuiteOrApt>string</SuiteOrApt>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <Zip5>string</Zip5>
          <Zip4>string</Zip4>
          <Phone>string</Phone>
          <Extension>string</Extension>
        </MailingAddress>
        <PaymentDetailsDeferred>boolean</PaymentDetailsDeferred>
        <USPSRep>string</USPSRep>
        <DedicatedResellerAccount>boolean</DedicatedResellerAccount>
        <ICertify>boolean</ICertify>
      </UserSignUpRequest>
    </GetUserSignUp>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
TokenRequested true or false Returns a security token to be used in account API requests. Used in lieu of PassPhrase. Unique to the AccountID created in the response. By default do not return security token
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the partner making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
FirstName String
(25 Characters)
Customer’s first name
Note: The USPS requires that a real name is entered into the name elements.
MiddleName String
(25 Characters)
Customer’s middle name
LastName String
(50 Characters)
Customer’s last name
Title String
(50 Characters)
Customer’s contact title
EmailAddress String
(120 Characters)
Customer’s email address
PhoneNumber 0-9 (xxx-xxx-xxxx) Customer’s phone number
PhoneNumberExt String
(10 Characters)
Customer’s phone extension
FaxNumber String
(9 Characters)
Customer’s fax number
BillingType TS Type of billing (TS Default for LABELSERVER Product)
PartnerID String
(50 Characters)
PartnerID (also called Requester ID) uniquely identifies the system making the request. Endicia assigns this ID.
OriginatingIpAddress String
(20 Characters)
Customer’s IP Address
Contracts <Contract> Object Contract ID for custom rate cards
Show <Contract> Object
Element Type/Value Description
ContractId String
(30 Characters)
Maximum two: one for domestic rates and one for international rates

AccountCredentials <AccountCredentials> Object Account credentials defined by customer
Show <AccountCredentials> Object

Element Type/Value Description
WebPassword String
(17 Characters)
Customer’s Internet Password (Needs to be greater than eight characters)
TemporaryPassPhrase String
(64 Characters)
Customer’s account Pass Phrase (Needs to be greater than eight characters, and different from the Web Password)
SecurityQuestion String
(50 Characters)
Question to be asked if the password is forgotten
(Needs to be at least 5 characters)
SecurityAnswer String
(50 Characters)
The answer to the security question (Must be at least 5 characters)

CreditCard <CreditCard> Object If <PaymentDetailsDeferred> is TRUE, this node is not required.
Show <CreditCard> Object

Element Type/Value Description
CreditCardNumber String
(9 Characters)
Credit card number
CreditCardType Visa
Mastercard
AmericanExpress
CarteBlanche
Discover
DinersClub
Credit card type
CreditCardMonth January - December Credit card expiration month name
CreditCardYear String
(4 Characters)
Four-digit representation of the credit card expiration year
CreditCardAddress String
(50 Characters)
Address used with credit card
CreditCardCity String
(50 Characters)
City used for the credit card
CreditCardState String
(2 Characters)
State used with the credit card
CreditCardZip5 String
(5 Characters)
ZIP Code used with the credit card
CreditCardCVV String
(5 Characters)
3 or 4 digit card verification value or security code
CreditCardCountryCode String
(2 Characters)
2 digit ISO country code of the credit card address

CheckingAccount <CheckingAccount> Object Used to specify ACH payment
Show <CheckingAccount> Object

Element Type/Value Description
AccountNumber String
(15 Characters)
Checking account number (Required if Payment Type is ACH)
RoutingNumber String
(15 Characters)
Routing number of checking account (Required if payment type is ACH)

PhysicalAddress <Address> Object Physical location to register account
Show <Address> Object

Element Type/Value Description
FirstName String
(25 Characters)
Customer’s first name
LastName String
(50 Characters)
Customer’s last name
CompanyName String
(50 Characters)
Customer’s company name
SuiteOrApt String
(15 Characters)
Customer’s mailing suite or apt.
Address String
(50 Characters)
Customer’s mailing address
City String
(50 Characters)
Customer’s mailing city
State String
(2 Characters)
Customer’s mailing state
Zip5 String
(5 Characters)
Customer’s mailing ZIP Code
Zip4 String
(4 Characters)
Customer’s mailing +4
Phone String
(9 Characters)
Customer’s phone, if different
Extension String
(10 Characters)
Customers extension, if different

MailingAddress <Address> Object Customer’s mailing address (if different than physical address)
Show <Address> Object

Element Type/Value Description
FirstName String
(25 Characters)
Customer’s first name
LastName String
(50 Characters)
Customer’s last name
CompanyName String
(50 Characters)
Customer’s company name
SuiteOrApt String
(15 Characters)
Customer’s mailing suite or apt.
Address String
(50 Characters)
Customer’s mailing address
City String
(50 Characters)
Customer’s mailing city
State String
(2 Characters)
Customer’s mailing state
Zip5 String
(5 Characters)
Customer’s mailing ZIP Code
Zip4 String
(4 Characters)
Customer’s mailing +4
Phone String
(9 Characters)
Customer’s phone, if different
Extension String
(10 Characters)
Customers extension, if different

PaymentDetailsDeferred true or false Customer can obtain rates but cannot buy postage or print labels. Default. Customer can access all features based on BillingType.
USPSRep String
(10 Characters
USPS Rep if applicable
DedicatedResellerAccount true or false Internal use – do not submit this element in your request.
ICertify true or false I certify that all information provided above is accurate and truthful. I also certify that I have
read and understood the following:

GetUserSignup Response

<GetUserSignup> Response

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>
    <GetUserSignUpResponse xmlns="www.envmgr.com/LabelService">
      <UserSignUpResponse>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <Token>string</Token>
        <ConfirmationNumber>long</ConfirmationNumber>
        <AccountID>long</AccountID>
      </UserSignUpResponse>
    </GetUserSignUpResponse>
  </soap:Body>
</soap:Envelope>

Element Type/Value Description
ErrorMessage String
(150 Characters)
Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
ConfirmationNumber Numeric
(6 Digits)
Confirmation Number of sign up.
AccountID Numeric
(7 Digits)
Account Number for new account.
Token String
(150 Characters)
Security token to be used in account API requests. Used in lieu of PassPhrase.

ChangePassPhrase

To change the Pass Phrase for an account, use the ChangePassPhrase or the ChangePassPhraseXML web method of the Endicia Label Server Web Service.

Set the TokenRequested attribute to true to enable your transactions to use the <Token> instead of the <AccountID> and <PassPhrase>. This will enhance account security as these values are no longer passed in the requests. You can still use the <AccountID> and <PassPhrase>in your requests, but you cannot use all three (<AccountID>, <PassPhrase> and <Token>) in the same request.

To change the current Token value, run the ChangePassPhraseRequest with TokenRequested set to true and a new PassPhrase in the NewPassPhrase element. You cannot use previously used PsssPhrase values for the same account.

You can revert to the <AcccountID> and <PassPhrase> by running the ChangePassPhraseRequest and setting the TokenRequested attribute to false. From that point on, the <Token> will become stale and can no longer be used.

ChangePassPhrase Request

<ChangePassPhrase> Request

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

<?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>
    <ChangePassPhrase xmlns="www.envmgr.com/LabelService">
      <ChangePassPhraseRequest TokenRequested="boolean">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <NewPassPhrase>string</NewPassPhrase>
      </ChangePassPhraseRequest>
    </ChangePassPhrase>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
TokenRequested true or false Returns a security token to be used in account API requests. Used in lieu of PassPhrase. Unique to the AccountID created in the response. By default, do not return security token
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

NewPassPhrase String
(64 Characters)
New Pass Phrase for the Endicia postage account.
Pass Phrase must be at least eight characters with a maximum of 64 characters. For added security, the Pass Phrase should be at least 10 characters and include more than one word, use at least one uppercase and lowercase letter, one number and one non-text character (for example, punctuation). A Pass Phrase that has been used previously will be rejected.

Notes

Set the TokenRequested attribute to true to enable your transactions to use the <Token> instead of the <AccountID> and <PassPhrase>. This will enhance account security as these values are no longer passed in the requests. You can still use the <AccountID> and <PassPhrase> in your requests, but you cannot use all three (<AccountID>, <PassPhrase> and <Token>) in the same request.

To change the current Token value, run the ChangePassPhraseRequest with TokenRequested set to true and a new PassPhrase in the NewPassPhrase element. You cannot use previously used PassPhrase values for the same account.

You can revert to the <AccountID> and <PassPhrase> by running the ChangePassPhraseRequest and setting the TokenRequested attribute to false. From that point on, the <Token> will become stale and can no longer be used.

ChangePassPhrase Response

<ChangePassPhrase> Response

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>
    <ChangePassPhraseResponse xmlns="www.envmgr.com/LabelService">
      <ChangePassPhraseRequestResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <Token>string</Token>
      </ChangePassPhraseRequestResponse>
    </ChangePassPhraseResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String
(150 Characters)
Error Message
Base64LabelImage Base64 string Image of the label. If the Label node is present, then this element will not exist. See Note Base64 Image Locations.
Label Array of <Image> objects Contains one or more <Image> elements for each part of the label.
Show <Image> Object
Element Type/Value Description
Image Base64 String Part of the label image.
PartNumber Numeric Attribute Partnumber of Image

CustomsForm Array of <Image> objects Contains one or more <Image> elements for each part of the customs form.

Note: The CustomsForm node is retained for backward compatibility only.

Show <Image> Object

Element Type/Value Description
Image Base64 String Part of the label image.
PartNumber Numeric Attribute Partnumber of Image

PIC String Same as TrackingNumber. For domestic mail pieces only.
CustomsNumber String
(13 Characters)
Customs form number.
TrackingNumber String For domestic mail, this value is also copied to the PIC element. For international mail and domestic mail using customs forms, this value is also copied to the CustomsNumber element. Note: With the migration from Planet Code technology to IMb technology for DestinationConfirm services, the TrackingNumber returned can be up to 31 characters long.
FinalPostage Currency Total postage and fees for transaction.
TransactionID Long Unique ID for transaction - corresponds to the piece count for the account used.
TransactionDateTime Datetime
(YYYYMMDDHHMMSS)
Date and time the transaction was created. Expressed in UTC.
PostmarkDate Date
(YYYYMMDD)
Indicates the postmark date.
PostageBalance Currency Remaining postage balance after label is generated, in dollars and cents (mils).
ReferenceID String
(50 Characters)
A reference value for logs.
CostCenter Numeric
(8 Digits)
Cost-center code for accounting purposes.
HfpFacilityID String
(50 Characters)
Destination Facility ID.
HfpFacilityName String
(50 Characters)
Destination Facility Name.
HfpFacilityAddress1 String
(50 Characters)
Destination Facility Address.
HfpFacilityCity String
(50 Characters)
Destination Facility City.
HfpFacilityState String
(50 Characters)
Destination Facility State.
HfpFacilityPostalCode String
(25 Characters)
Destination Facility 5-Digit ZIP Code.
HfpFacilityZIP4 String
(5 Characters)
Destination Facility +4.
PostagePrice <PostagePrice> Postage price for transaction.
Show <PostagePrice> Object

Element Type/Value Description
TotalAmount Currency Attribute of <PostagePrice> defining total amount of postage and fees. This value is also copied to the FinalPostage element.
Postage <Postage> Object Object breakdown of total postage assessed.
Show <Postage> Object

Element Type/Value Description
TotalAmount Currency Total amount of postage.
MailService String
(50 Characters)

Description of MailClass requested. For instance, a PostagePrice object with MailClass PriorityMailInternational will display Priority Mail International for the MailService.
Zone String
(0 (local zone) through 9)

Number of postal rate zones between the sender’s and recipient’s ZIP Codes. Applies only to domestic mail.
IntraNDC true or false Zone is Intra-NDC.
Zone is Inter-NDC.

Applies only to domestic mail.

Pricing
<Pricing> Datatype

Commercial
CommercialBase
CommercialPlus
NSA
Retail

USPS pricing level associated with returned postage estimate.
Fees <Fees> Object Object breakdown of fees associated with postage
Show <Fees> Object
Element Type/Value Description
TotalAmount Currency Total amount of fees.
CertificateOfMailing Currency Certificate of Mailing fee.
For future use.

CertifiedMail Currency Certified Mail fee.
CollectOnDelivery Currency Collect on Delivery (COD) fee.
For future use.

DeliveryConfirmation Currency Delivery Confirmation fee.
ElectronicReturnReceipt Currency Electronic Return Receipt fee.
InsuredMail Currency Insured Mail fee.
RegisteredMail Currency Registered Mail fee.
For future use.

RestrictedDelivery Currency Restricted Delivery fee.
ReturnReceipt Currency Return Receipt fee.
ReturnReceiptForMerchandise Currency Return Receipt for Merchandise fee.
For future use.

SignatureConfirmation Currency Signature Confirmation fee.
SpecialHandling Currency Special Handling fee.
For future use.

AdultSignature Currency Adult Signature fee.
AdultSignatureRestrictedDelivery Currency Adult Signature Restricted Delivery fee.
LiveAnimalSurcharge Currency Live Animal Surcharge fee.
DeliveryTimeDays Numeric (1 Digit) Delivery time in days
EstimatedDeliveryDate Date
(d/m/yyyy)

Estimated delivery date
Note: Applies only to Priority and Priority Mail Express.

AMDelivery Numeric AM Delivery fee for Priority Mail Express packages.
GroupedExtraServices <GroupedExtraServices> Object Container for Extra Services and associated fees.
Show <GroupedExtraServices>Object

Element Type/Value Description
Services SignatureConfirmation;RestrictedDelivery
CertifiedMail;RestrictedDelivery
CertifiedMail;AdultSignature
CertifiedMail;AdultSignatureRestrictedDelivery

Extra services subscribed
FeeAmount Currency Amount for Grouped Service

RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the partner making the request. Endicia assigns this ID.
ReferenceID2 String
(50 Characters)
A reference value for your logs.
ReferenceID3 String
(50 Characters)
A reference value for your logs.
ReferenceID4 String
(50 Characters)
A reference value for your logs.
CostCenterAlphaNumeric String
(50 Characters)
Cost-center code for accounting purposes.

Note: This element serves the same purpose as the preceding CostCenter element. Use this element if the cost center values are alphanumeric.Do not use both these elements together.

Indicium

Deprecated
BarcodeDisplay

Deprecated
BarcodeNumber

Deprecated
Banner

Deprecated
RDC

Deprecated
RoutingNumber

Deprecated
DeliveryTimeDays Numeric
(1 Digit)
Delivery time in days
DHLInboundSortCode

Deprecated
DHLOutboundSortCode

Deprecated
DHLDestMailTerminal

Deprecated
DHLMailType

Deprecated
DHLITVersion

Deprecated
DHLServiceLevel

Deprecated
PriorityMailExpressCommitments

Deprecated
SequenceNumber

Deprecated
ResellerInformation

Deprecated
EstimatedDeliveryDate Date
(d/m/yyyy)
Estimated delivery date Note: Applies only to Priority and Priority Mail Express.
SDRValue Deprecated

UpdatePaymentInformation

Use the UpdatePaymentInformation web method to update or add the payment method on file for an existing Endicia Account.

UpdatePaymentInformation Request

<UpdatePaymentInformation> Request

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

<?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>
    <UpdatePaymentInformation xmlns="www.envmgr.com/LabelService">
      <UpdatePaymentInfoRequest ResponseVersion="string">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
        <UpdateCreditCardInfo PaymentType="Postage or ServiceFees or Both">
          <CreditCardNumber>string</CreditCardNumber>
          <CreditCardCVV>string</CreditCardCVV>
          <CreditCardAddress>string</CreditCardAddress>
          <CreditCardAddress2>string</CreditCardAddress2>
          <CreditCardAddress3>string</CreditCardAddress3>
          <CreditCardCity>string</CreditCardCity>
          <CreditCardState>string</CreditCardState>
          <CreditCardZipCode>string</CreditCardZipCode>
          <CreditCardCountryCode>string</CreditCardCountryCode>
          <CreditCardType>Visa or
                          Mastercard or
                          AmericanExpress or
                          CarteBlanche or
                          Discover or
                          DinersClub
          </CreditCardType>
          <CreditCardExpMonth>January or
                              February or
                              March or
                              April or
                              May or
                              June or
                              July or
                              August or
                              September or
                              October or
                              November or
                              December
          </CreditCardExpMonth>
          <CreditCardExpYear>string</CreditCardExpYear>
        </UpdateCreditCardInfo>
        <UpdateACHInfo PaymentType="Postage or ServiceFees or Both">
          <CheckingAccountNumber>string</CheckingAccountNumber>
          <CheckingAccountRoutingNumber>string</CheckingAccountRoutingNumber>
        </UpdateACHInfo>
      </UpdatePaymentInfoRequest>
    </UpdatePaymentInformation>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the partner making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

UpdateCreditCardInfo <CreditCard> Object Use Attribute <PaymentType> to specify what to use card for: Postage, ServiceFees, or Both
Show <CreditCardUpdate> Object

Element Type/Value Description
CreditCardNumber String
(9 Characters)
Credit card number
CreditCardCVV String
(5 Characters)
3 or 4 digit card verification value or security code
CreditCardAddress String
(50 Characters)
Address used with credit card
CreditCardAddress2 String
(50 Characters)
Address used with credit card
CreditCardAddress3 String
(50 Characters)
Address used with credit card
CreditCardCity String
(50 Characters)
City used for the credit card
CreditCardState String
(2 Characters)
State used with the credit card
CreditCardZip5 String
(5 Characters)
ZIP Code used with the credit card
CreditCardCountryCode String
(2 Characters)
2 digit ISO country code of the credit card address
CreditCardType Visa
Mastercard
AmericanExpress
CarteBlanche
Discover
DinersClub
Credit card type
CreditCardMonth January - December Credit card expiration month name
CreditCardYear String
(4 Characters)
Four-digit representation of the credit card expiration year

UpdateACHInfo <CheckingAccount> Object Use Attribute <PaymentType> to specify what to use ACH for: Postage, ServiceFees, or Both
Show <CheckingAccountUpdate> Object

Element Type/Value Description
CheckingAccountNumber String
(50 Characters)
Checking account number (Required if Payment Type is ACH)
CheckingAccountRoutingNumber String
(50 Characters)
Routing number of checking account (Required if payment type is ACH)

PhysicalAddress <Address> Object Physical location to register account
Show <Address> Object

Element Type/Value Description
FirstName String
(25 Characters)
Customer’s first name
LastName String
(50 Characters)
Customer’s last name
CompanyName String
(50 Characters)
Customer’s company name
SuiteOrApt String
(15 Characters)
Customer’s mailing suite or apt.
Address String
(50 Characters)
Customer’s mailing address
City String
(50 Characters)
Customer’s mailing city
State String
(2 Characters)
Customer’s mailing state
Zip5 String
(5 Characters)
Customer’s mailing ZIP Code
Zip4 String
(4 Characters)
Customer’s mailing +4
Phone String
(9 Characters)
Customer’s phone, if different
Extension String
(10 Characters)
Customers extension, if different

MailingAddress <Address> Object Customer’s mailing address (if different than physical address)
Show <Address> Object

Element Type/Value Description
FirstName String
(25 Characters)
Customer’s first name
LastName String
(50 Characters)
Customer’s last name
CompanyName String
(50 Characters)
Customer’s company name
SuiteOrApt String
(15 Characters)
Customer’s mailing suite or apt.
Address String
(50 Characters)
Customer’s mailing address
City String
(50 Characters)
Customer’s mailing city
State String
(2 Characters)
Customer’s mailing state
Zip5 String
(5 Characters)
Customer’s mailing ZIP Code
Zip4 String
(4 Characters)
Customer’s mailing +4
Phone String
(9 Characters)
Customer’s phone, if different
Extension String
(10 Characters)
Customers extension, if different

PaymentDetailsDeferred true or false Customer can obtain rates but cannot buy postage or print labels. Default. Customer can access all features based on BillingType.
USPSRep String
(10 Characters
 
DedicatedResellerAccount true or false Internal use – do not submit this element in your request.
ICertify true or false I certify that all information provided above is accurate and truthful. I also certify that I have
read and understood the following:

Notes

UpdatePaymentInformation Response

<UpdatePaymentInformation> Response

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>
    <UpdatePaymentInformationResponse xmlns="www.envmgr.com/LabelService">
      <UpdatePaymentInfoResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
      </UpdatePaymentInfoResponse>
    </UpdatePaymentInformationResponse>
  </soap:Body>
</soap:Envelope>

Element Type/Value Description
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.

GetAccountStatus

To get the status of an account, use the GetAccountStatus or the GetAccountStatusXML web method of the Endicia Label Server Web Service. For accounts with an Active status, the response contains other useful information, such as the remaining postage balance in the account.

GetAccountStatus Request

<GetAccountStatus> Request

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

<?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>
    <GetAccountStatus xmlns="www.envmgr.com/LabelService">
      <AccountStatusRequest ResponseVersion="0 or 1">
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </AccountStatusRequest>
    </GetAccountStatus>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account authentication information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
PassPhrase String
(64 Characters)
Pass Phrase for the Endicia postage account.
Token String
(150 Characters)
Security Token. Use only if your account is set up to use the Token. If using the Token, DO NOT supply the AccountID and PassPhrase elements.

GetAccountStatus Response

<GetAccountStatus> Response

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

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>
    <GetAccountStatusResponse xmlns="www.envmgr.com/LabelService">
      <AccountStatusResponse>
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <SerialNumber>int</SerialNumber>
          <PostageBalance>decimal</PostageBalance>
          <AscendingBalance>decimal</AscendingBalance>
          <AccountStatus>string</AccountStatus>
          <DeviceID>string</DeviceID>
          <ReferenceID>string</ReferenceID>
        </CertifiedIntermediary>
        <Discounts>
          <PriorityMail Discount="ComBase or CPP or Custom"
                        CubicPricing="boolean"
                        FlatRatePaddedEnvelope="boolean"
                        HalfPoundRate="boolean"
                        RegionalRateBox="boolean"
                        OpenAndDistribute="boolean" />
          <PMExpress Discount="ComBase or CPP or Custom"
                     CubicPricing="boolean"
                     FlatRatePaddedEnvelope="boolean"
                     HalfPoundRate="boolean"
                     RegionalRateBox="boolean"
                     OpenAndDistribute="boolean" />
          <FCPS Discount="ComBase or CPP or Custom"
                CubicPricing="boolean"
                FlatRatePaddedEnvelope="boolean"
                HalfPoundRate="boolean"
                RegionalRateBox="boolean"
                OpenAndDistribute="boolean" />
          <PMI Discount="ComBase or CPP or Custom" />
          <EMI Discount="ComBase or CPP or Custom" />
          <FCPIS Discount="ComBase or CPP or Custom" />
        </Discounts>
        <AccountType>USPS or Retail</AccountType>
        <ApprovedShipper>boolean</ApprovedShipper>
        <ConsolidatorServices>boolean</ConsolidatorServices>
        <ConsolidatorServiceDetail>
          <InternationalConsolidator>boolean</InternationalConsolidator>
          <EnabledInternationalConsolidatorServices>
            <EnabledInternationalConsolidatorService xsi:nil="true" />
            <EnabledInternationalConsolidatorService xsi:nil="true" />
          </EnabledInternationalConsolidatorServices>
        </ConsolidatorServiceDetail>
        <ContractID>
          <DomesticCID>string</DomesticCID>
          <InternationalCID>string</InternationalCID>
        </ContractID>
        <InsuranceAgreement>boolean</InsuranceAgreement>
        <AccountStatus>
          <Status>string</Status>
          <ReturnCode>int</ReturnCode>
        </AccountStatus>
        <ControlRegister>decimal</ControlRegister>
        <LicenseZip5>string</LicenseZip5>
        <Address>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Address1>string</Address1>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <ZipCodeAddOn>string</ZipCodeAddOn>
          <PhoneNumber>string</PhoneNumber>
        </Address>
        <AccountFeatures>
          <Feature>
            <Code>string</Code>
            <Name>string</Name>
            <IsEligible>boolean</IsEligible>
            <IsActive>boolean</IsActive>
            <TermsAndConditionsLink>string</TermsAndConditionsLink>
          </Feature>
          <Feature>
            <Code>string</Code>
            <Name>string</Name>
            <IsEligible>boolean</IsEligible>
            <IsActive>boolean</IsActive>
            <TermsAndConditionsLink>string</TermsAndConditionsLink>
          </Feature>
        </AccountFeatures>
      </AccountStatusResponse>
    </GetAccountStatusResponse>
  </soap:Body>
</soap:Envelope>
Element Type/Value Description
ResponseVersion 0 OR 1 0 for basic account information and balance, 1 for all informaiton.
Status Numeric 0 for success, otherwise, see Errors
ErrorMessage String (150 Characters) Error Message
RequesterID String
(4 Characters)
Requester ID (also called Partner ID) uniquely identifies the system making the request. Endicia assigns this ID.
RequestID String
(50 Characters)
Request ID that uniquely identifies this request. This will be returned in response.
CertifiedIntermediary <CertifiedIntermediary> Object Certified Intermediary (CI) account information.
Show <CertifiedIntermediary> Object
Element Type/Value Description
AccountID String
(7 Characters)
Account ID for the Endicia Postage Account
SerialNumber Numeric
(12 Digits)
The Serial Number of the last item created on the account.
PostageBalance Currency Remaining postage balance after re-credit in dollars and cents (mils).
AscendingBalance Currency Total amount of postage printed (after re-credit) in dollars and cents (mils).
Account Status String
(1 Character)
Account Status flag: A for Active
DeviceID String
(12 Characters)
The account's 12 character Device ID (that appears in the indicium).
Discounts <Discounts> Object Account-level discount information for each mail type.
Show <Discounts> Object
Element Type/Value Description
PriorityMail <PriorityMailDiscount> Object All applicable account-level discounts for Priority Mail
<PriorityMailDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
CubicPricing true OR false Specifies whether Cubic Pricing applies
FlatRatePaddedEnvelope true OR false Specifies whether eligble for FlatRatePaddedEnvelope
HalfPoundRate true OR false Specifies whether Half Pound Rate applies
RegionalRateBox true OR false Specifies whether eligible for RegionalRateBox
OpenAndDistribute true OR false Specifies whether eligible for OpenAndDistribute
PMExpress <PMExpressDiscount> Object All applicable account-level discounts for PMExpress
<PMExpressDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
CubicPricing true OR false Specifies whether Cubic Pricing applies
FlatRatePaddedEnvelope true OR false Specifies whether eligble for FlatRatePaddedEnvelope
HalfPoundRate true OR false Specifies whether Half Pound Rate applies
RegionalRateBox true OR false Specifies whether eligible for RegionalRateBox
OpenAndDistribute true OR false Specifies whether eligible for OpenAndDistribute
FCPS <FCPSDiscount> Object All applicable account-level discounts for FCPS
<FCPSDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
CubicPricing true OR false Specifies whether Cubic Pricing applies
FlatRatePaddedEnvelope true OR false Specifies whether eligble for FlatRatePaddedEnvelope
HalfPoundRate true OR false Specifies whether Half Pound Rate applies
RegionalRateBox true OR false Specifies whether eligible for RegionalRateBox
OpenAndDistribute true OR false Specifies whether eligible for OpenAndDistribute
PMI <PMIDiscount> Object All applicable account-level discounts for PMI
<PMIDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
EMI <EMIDiscount> Object All applicable account-level discounts for EMI
<EMIDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
FCPIS <FCPISDiscount> Object All applicable account-level discounts for FCPIS
<FCPISDiscount> Object
Discount ComBase OR CPP OR Custom Level of Discounted Rate
AccountType USPS OR Retail Specifies whether USPS owned-meter or retail meter
ApprovedShipper true OR false The account is enabled as an Approved Shipper
ConsolidatorServices true OR false Account is enabled for Consolidator Services
ConsolidatorServiceDetail <ConsolidatorServiceDetail> Object Object detailing Consolidator Services enabled
ContractID <ContractID> Object Object detailing contracts enabled
InsuranceAgreement true OR false The account is enabled for Endicia Parcel Insurance.
AccountStatus <AccountStatus> Object Deprecated
ControlRegister Numeric Deprecated
LicenseZip5 String
(5 Characters)
Deprecated
Address <Address> Object Registered Address
AccountFeatures Array of <Feature> Objects Enumerates special features and their settings.
<Feature> Object
Code String
(50 Characters)
Code that specifies feature
Name String
(200 Characters)
Description of the feature specified.
IsEligible true OR false Specifies whether eligble for specified feature
IsActive true OR false Specifies whether account is active on specified feature
TermsAndConditionsLink true OR false Link to the Terms and Conditions

Appendix

Hold For Pickup

The Hold For Pickup service allows mailpieces to be held at a designated Post Office location for pickup by a specified addressee or designee. The customer is notified by email or SMS text message (provided by the mailer or shipper as part of the label creation) that a package is available for pickup. This service provides the shipper with the date and time that the addressee took possession of the item. If the item has not been picked up within 5 days, the Post Office will make a second attempt to notify the addressee. The item will be returned to the sender if not picked up within 15 days. The Hold For Pickup service is available with Priority Mail Express, Priority Mail, First-Class Mail parcels, and Parcel Select Ground parcels.

There is no charge for the Hold For Pickup service. Delivery Confirmation is included by default, or you can also select Signature Confirmation. USPS Insurance for a declared value greater than $200 can be optionally selected. No other services are available with Hold For Pickup service at this time.

Label Server will return a Hold For Pickup facility. However, if you prefer to obtain that information yourself, you can use USPS Web Tools (www.usps.com/webtools) to obtain the facility information to enter into your request in the elements listed below.

Label Server does not produce PS Form 3811, Domestic Return Receipt. PS Form 3811 must be manually completed and attached to the package with the label. These forms can be obtained from the US Postal Service.

Open and Distribute

Priority Mail Open and Distribute (PMOD) and Priority Express Mail Open and Disribute (EMOD) service is available. Use this service to send parcels, such as Parcel Select entry facility presorted pieces to the destination Post Office to be processed and entered at a discount. See Presorting Features for Parcel Select settings.

Many mailing houses use Open and Distribute Service to send Every Door Direct Mail (EDDM) mail to destination Post Offices for delivery to neighborhoods and targeted marketing areas.

Presorting Features

One of the advantages of using PC Postage is the ability to use USPS presort discount rates that are not available through retail channels. Among these are the Parcel Select Commercial discounts.

The following tables correspond to the USPS Price List (Notice 123) and can be used with Label Server to obtain lower rates. Contact your local USPS Business Service Network (BSN) representative for details specific to your mailing circumstances. For more information, see https://ribbs.usps.gov/locators/find-bsn.cfm.

Parcel Select Destination Entry

COMMERCIAL PARCELS—MACHINABLE

SortType EntryFacility
Presorted DDU
Presorted DSCF
Presorted DNDC

Parcel Select Destination Entry

COMMERCIAL PARCELS—NONMACHINABLE

SortType EntryFacility
Presorted DDU
FiveDigit DSCF
ThreeDigit DSCF
Presorted DNDC

Parcel Select Ground

COMMERCIAL PARCELS

SortType EntryFacility
Nonpresorted Other

Parcel Select Lightweight

COMMERCIAL PARCELS

SortType EntryFacility POZipCode
FiveDigit DDU Required
FiveDigit DSCF Required
FiveDigit DNDC Required
SCF DSCF Required
SCF DNDC Required
NDC DNDC Required
NDC Other Not Required
MixedNDC Other Not Required

LabelType, LabelSize, and MailpieceShape by MailClass

The following table shows the valid combinations that can be used with the available mail classes. Note that LabelType and LabelSize Attributes, and the MailpieceShape Element are optional, and may be excluded from the request (or null) if you want the default result. For LabelType Domestic or International, see Integrated Customs Form Options.

For a detailed listing of the various services and combinations of services available, please visit the USPS website at https://www.usps.com/business/add-extra-services.htm

LabelType MailpieceShape LabelSize Result EPL/ZPL
First-Class Package Service and First-Class Mail Parcel
Null or Default Null, Parcel, or IrregularParcel
Note: IrregularParcel is used only for First-Class Package Service Parcels which do not meet these criteria. A $0.20 surcharge will be applied.
Null or 4x6 4×6 Label Y
3.5x5.25 3.5×5.25 Label Y
4x4.5 4×4.5 Label Y
4x5 4×5 Label Y
4x8 4x6 Label with 2” Doctab Y
6x4 6×4 Label N
DocTab Eltron 4×6.75 Label Y
CertifiedMail Null, Flat, or Parcel Null or 4x6 4×5.375 Label
Note: LabelSize is ignored.
N
4x8 Eltron 4x8 Label Y
7x4 7×4 Label N
8x3 8×3 Label N
Booklet 8.675×4.5 Label N
EnvelopeSize10 #10 Envelope N
International
Note: MailClass FirstClassPackageInternationalService
Parcel Null or 4x6 Customs form Y
Domestic Flat or Parcel N/A Customs form Y
Note: Customs form not required for parcels less than 16 ounces.
4x8 4×6 Label with 2” Doctab Y
First-Class Card, Letter, and Flat
DestinationConfirm Card 6x4 6×4 Label Y
Letter or Flat Null or 7x3 7×3 Label N
6x4 6×4 Label Y
Dymo30384 DYMO 30384 Label N
EnvelopeSize10 #10 Envelope N
Mailer7x5 7×5 Label N
CertifiedMail Letter or Flat Null or 4x6 4×5.375 Label
Note: LabelSize is ignored.
N
4x8 Eltron 4x8 Label Y
7x4 7×4 Label N
8x3 8×3 Label N
Booklet 8.675×4.5 Label N
EnvelopeSize10 #10 Envelope N
International
Note: MailClass FirstClassMailInternational – Label Server returns a customs form for letter and flat shapes, although not required.
Letter or Flat Null or 4x6 Customs form Y
Default Flat 4x6 6×4 landscape Label Y
Priority Mail
Null or Default Null, Flat, Parcel, LargeParcel, and all RegionalRate and FlatRate shapes.
Note: This includes the new FlatRateLegalEnvelope, FlatRatePaddedEnvelope, FlatRateGiftCardEnvelope, FlatRateWindowEnvelope, FlatRateCardboardEnvelope, and SmallFlatRateEnvelope.
Null or 4x6 4×6 Label Y
3.5x5.25 3.5×5.25 Label Y
4x4.5 4×4.5 Label Y
4x5 4×5 Label Y
6x4 6×4 Label N
DocTab Eltron 4×6.75 Label Y
4x8 4×8 Label Y
CertifiedMail
Note: When using LabelType Default and choosing CertifiedMail from the Services node, MailpieceShape Letter is not an available option for Priority Mail.
Flat or Parcel Null or 4x6 4×5.375 Label
Note: LabelSize is ignored.
N
4x8 Eltron 4x8 Label Y
7x4 7×4 Label N
8x3 8×3 Label N
Booklet 8.675×4.5 Label N
EnvelopeSize10 #10 Envelope N
International
Note: MailClass PriorityMailInternational
Null, Flat, Parcel, FlatRateEnvelope, FlatRateLegalEnvelope, FlatRatePaddedEnvelope, or Small, Medium, or Large FlatRateBox Null Customs form Y
Note: Flat Rate Envelope or Small Flat Rate Box only.
4x6 Customs form Y
4x8 Customs form Y
Null Customs form Y
Domestic Null, Flat, Parcel, LargeParcel, and all RegionalRate and FlatRate shapes.
Note: This includes the new FlatRateLegalEnvelope, FlatRatePaddedEnvelope, FlatRateGiftCardEnvelope, FlatRateWindowEnvelope, FlatRateCardboardEnvelope, and SmallFlatRateEnvelope.
N/A Customs form Y
Note: Customs form not required for parcels less than 16 ounces.
4×8 4×8 Label with Doctab Y
Priority Mail Express
Null or Default Null, Letter, Flat, Parcel, or FlatRate and FlatRate Legal Envelope Null or 4x6 4×6 Label Y
4x4.5 4×4.5 Label Y
4x5 4×5 Label Y
4x8 4×6 Label with 2” Doctab Y
DocTab Eltron 4×6.75 Label Y
International
Note: MailClass PriorityMailExpressInternational
Null, Flat, Parcel, FlatRateEnvelope or FlatRateLegalEnvelope Null Customs form Y
Note: Flat Rate Envelope or Small Flat Rate Box only.
4x6 Customs form Y
4x8 Customs form with 2” Doctab Y
Null Customs form Y
Domestic Null, Flat, Parcel, and all RegionalRate and FlatRate shapes.
Note: This includes the new FlatRateLegalEnvelope, FlatRatePaddedEnvelope, FlatRateGiftCardEnvelope, FlatRateWindowEnvelope, FlatRateCardboardEnvelope, and SmallFlatRateEnvelope.
Null or 4x6 Customs form Y
Note: Customs form not required for parcels less than 16 ounces.
4x8 4×8 Label with Doctab Y
Library Mail and Media Mail
Null or Default Null or Parcel Null or 4x6 4×6 Label Y
3.5x5.25 3.5×5.25 Label Y
4x4 4x4 Label Y
4x4.5 4×4.5 Label Y
4x5 4×5 Label Y
4x8 4×6 Label with 2” Doctab Y
6x4 6×4 Label N
DocTab Eltron 4×6.75 Label Y
Domestic Null or Parcel Null or 4x6 Customs form Y
4x8 Customs form with 2” Doctab Y
Retail Ground, Parcel Select Ground and Parcel Select Lightweight
Null or Default Null, Parcel, IrregularParcel, or LargeParcel
IrregularParcel applies only to Parcel Select Lightweight; LargeParcel may be used to indicate Balloon Rate in lieu of entering the MailpieceDimensions.
Null or 4×6 4×6 Label Y
3.5x5.25 3.5×5.25 Label Y
4x4 4x4 Label Y
4x4.5 4x4.5 Label Y
4x5 4×5 Label Y
4x8 4×6 Label with 2” Doctab Y
6x4 6×4 Label N
DocTab Eltron 4×6.75 Label Y
Domestic Null or Parcel Null or 4x6 Customs form Y
4x8 Customs form with 2” Doctab Y

Endicia Bank-to-Bank Postage Payment Options

ACH Withdrawal (Direct Debit)

With the ACH Withdrawal method, you provide information about your checking account, and Endicia will withdraw the funds directly from your checking account and add the amount to your Endicia postage account balance. Endicia uses the USPS-authorized Federal Automated Clearing House (ACH) system to handle all payments. The purchase process in the client works exactly the same way with this method, and you can buy postage at any time to increase the balance in your Endicia account. If this payment method is used, your payment limits can be increased beyond the standard $500 restriction after an initial setup period.

The following Steps describe how to switch to direct debit.

Steps

  1. Log in to your online Endicia account at [https://www.endicia.com/Account/LogIn/]
  2. From the My Account tab, select Update Profile > Payment Method.
  3. Select the Deduct from my Checking Account… option.
  4. Enter your checking account and routing number.

Alternately, you can also contact support@endicia.com by email to switch.

ACH Credit (or Push) to the US Postal Service

The ACH Credit (Push) method allows you to transfer funds directly from your bank to the USPS. The USPS then transfers those funds to Endicia to add to your account balance. The primary advantages to this method are: no bank account information needs to be provided to Endicia and any amount of postage may be purchased. For customers who prefer to purchase in large amounts, this can be quite advantageous.

The following Steps describe how to add funds to your account balance using ACH Credit (Push).

  1. Instruct your bank to send an ACH TRANSFER (NOT A WIRE TRANSFER) to the USPS "lockbox" at Citibank. The account number is 30564608, and the Citibank ABA routing transit number is 021000089.
  2. Include your Endicia account number on the ACH Credit Transaction. Your bank may have a field for an "Invoice Number", "Order Number", "Individual or Company ID", or a note. If this information is omitted, your Endicia account cannot be credited for ten (10) business days or until another ACH transaction is made with your Endicia Account number in the proper field.
  3. Your bank may require additional verification of the transfer. The vendor name for the transfer is the "US Postal Service (Endicia)" and the tax ID is 41-0760000
  4. Expect the transfer to take 3-5 business to reach your Endicia account.

Wire transfer to Endicia

You can institute a wire transfer of funds from your bank to the Endicia bank account at Union Bank of California, and Endicia will subsequently transfer these funds into the USPS bank account. Please include your Endicia account number in the wire transfer notation field. Contact Endicia Accounting at accounting@endicia.com if you are interested in this method.

Pay by check

You can mail a check directly to Endicia to purchase postage. Make the check out to "Endicia Internet Postage", add your Endicia account number to the check or check stub, and mail to:

PSI Systems, Inc. Attn: Accounting Department 278 Castro St Mountain View, CA 94041-1204

The process to credit your account will take five business days after we receive the check.

EPL2 and ZPLII Guidelines

public static bool SendBytesToPrinter(string szPrinterName, byte[] bytes)
{
        Int32   nLength;
        IntPtr  pUnmanagedBytes;
        bool    bSuccess;

        pUnmanagedBytes = new IntPtr(0);
        nLength = Convert.ToInt32(bytes.Length);

        pUnmanagedBytes = Marshal.AllocCoTaskMem(nLength);

        Marshal.Copy(bytes, 0, pUnmanagedBytes, nLength);

        bSuccess = SendBytesToPrinter(szPrinterName, pUnmanagedBytes, nLength);

        Marshal.FreeCoTaskMem(pUnmanagedBytes);

        return(bSuccess);
}

        public static bool SendBytesToPrinter(string szPrinterName,
                        IntPtr pUnmanagedBytes, Int32 nLength)
    {
        DOCINFOA    di;
        Int32   dwError, dwWritten;
        IntPtr  hPrinter;
        bool    bSuccess;

        bSuccess = false;

        dwError = 0;
        dwWritten = 0;

        di = new DOCINFOA();
        di.pDocName = "ELS Label";
        di.pDataType = "RAW";

        hPrinter = new IntPtr(0);
        if (OpenPrinter(szPrinterName.Normalize(), out hPrinter, IntPtr.Zero) == true)
        {
            if (StartDocPrinter(hPrinter, 1, di) == true)
            {
                if (StartPagePrinter(hPrinter))
                {
                    bSuccess = WritePrinter(hPrinter, pUnmanagedBytes, nLength,
                                out dwWritten);
                    EndPagePrinter(hPrinter);
                }
                EndDocPrinter(hPrinter);
            }
            ClosePrinter(hPrinter);
        }

        if (bSuccess == false)
        {
            dwError = Marshal.GetLastWin32Error();
        }

        return(bSuccess);
    }

For certain label layouts, the Endicia Label Server Web Service can generate label images in the Zebra native printer languages, EPL2 and ZPLII. The label image can contain both text and binary data. To ensure that the USPS can successfully scan the barcodes in the label, care must be taken to preserve the raw printer data when sending the label image to the Zebra printer.

Note: To ascertain that the 2-D data matrix barcode is scanned properly, the format for the 2-D data matrix barcode will be migrated from the data stream type to the image type in version version 6.3.

For available EPL2 and ZPLII formats, see the LabelType, LabelSize, and MailpieceShape by MailClass section.

Some guidelines to follow when printing EPL2 and ZPLII labels to Zebra printers include:

StatusCode Definitions

Status Code String Status Message
(-1) Not Found
(0) Found – No Status
(A) Logged at USPS
C Customer Recall
D Delivered
E Dead Letter
F Forwarded to New Address
(I) Scanned in Route
L Notice Left for Recipient
(N) New Item
O Out for Delivery
P Available for Pickup
R Returned to Sender
U Undeliverable
V Delivery Status Not Updated
(X) Other

CountryCodes

The following table shows the country code to be used in the ToCountryCode element and the CountryOfOrigin element in an international Label Request.

In some cases, the ISO 3166 standard has identified Country Codes for Territories or Provinces of other countries. If there is a country name in the “Use” column, you may need to confirm which code is expected by the receiving country.

For updated information, see the following sources:

Country Name Country Code Includes
Afghanistan  AF
Albania AL
Algeria DZ
Andorra AD
Angola AO
Anguilla AI
Antigua and Barbuda AG Antigua; Barbuda; Redonda
Argentina AR
Armenia AM
Aruba AW
Ascension Included in Saint Helena
Australia AU Christmas Island; Cocos Island; Keeling Islands; Lord Howe Island; Norfolk Island; Thursday Island
Use the following Province or Territory Codes in the <ToState> element.
<ToState> Element
ToState State or Territory
ACT Australian Capital Territory
JBT Jarvis Bay Territory
NSW New South Wales
NT Northern Territory
QLD Queensland
SA South Australia
TAS Tasmania
VIC Victoria
WA Western Australia
Austria AT
Azerbaijan AZ
Bahamas BS
Bahrain BH
Bangladesh BD
Barbados BB
Belarus BY
Belgium BE
Belize BZ
Benin BJ Dahomey
Bermuda BM
Bhutan BT
Bolivia BO
Bonaire, Sint Eustatius, and Saba BQ Bonaire; Saba; Sint Eustatius
Bosnia-Herzegovina BA
Botswana BW
Brazil BR
British Virgin Islands VG
Brunei Darussalam BN
Bulgaria BG
Burkina Faso BF
Burma Included in Myanmar
Burundi  BI
Cambodia KH Kampuchea 
Cameroon CM
Canada CA Use the following Province or Territory Codes in the <ToState> element.
<ToState> Element
ToState Province/Territory
AB Alberta
BC British Columbia
MB Manitoba
NB New Brunswick
NL Newfoundland and Labrador
NT Northwest Territories
NS Nova Scotia
NU Nunavut
ON Ontario
PE Prince Edward Island
QC Quebec
SK Saskatchewan
YT Yukon
Cape Verde CV
Cayman Islands KY
Central African Republic CF
Chad TD Tchad
Chile CL
China CN Manchuria; Tibet
Colombia CO
Comoros KM Anjouan; Grand Comoro; Moheli 
Congo, Democratic Republic of the CD
Congo, Republic of the CG
Costa Rica CR
Cote d'Ivoire CI Ivory Coast
Croatia HR
Cuba CU Isle of Pines, West Indies
Curacao CW
Cyprus CY
Czech Republic CZ
Denmark DK
Djibouti DJ Issas 
Dominica DM
Dominican Republic DO
Ecuador EC
Egypt EG
El Salvador SV Salvador
Equatorial Guinea GQ Annobon Island; Corisco Island; Elobey Islands; Fernando Po; Rio Muni
Eritrea ER
Estonia EE
Ethiopia ET
Falkland Islands FK South Georgia
Faroe Islands FO
Fiji FJ
Finland FI Aland Islands; Corsica
France FR Mayotte; Monaco
French Guiana   GF
French Polynesia PF Borabora; French Oceania; Gambier; Hivaoa; Huahine; Marquesas Islands; Moorea; Nukahiva; Raiatea; Rapa; Society Islands; Tahaa; Tahiti; Tuamotou; Tubuai
Gabon GA
Gambia GM
Georgia, Republic of GE
Germany DE
Ghana GH
Gibraltar GI
Great Britain and Northern Ireland GB Includes Alderney; Channel Islands; England; Guernsey; Isle of Man; Jersey; Northern Ireland; Sark; Scotland; United Kingdom; Wales
Greece GR Astypalaia; Chalki; Crete; Dodecanese Islands; Kalymnos; Karpathos; Kassos; Kastellorizon; Kos; Leipsos; Leros; Nissiros; Patmos; Rodos; Symi; Tilos
Greenland GL
Grenada GD
Guadeloupe GP Barthelemy; Desirade Island; French West Indies; Les Saints Island; Marie Galante; Petite Terre; Saint Barthelemy; Saint Bartholomew; Saint Martin (French)
Guatemala GT
Guinea GN
Guinea-Bissau GW
Guyana GY British Guiana
Haiti HT
Honduras   HN Swan Islands
Hong Kong HK Kowloon
Hungary HU
Iceland IS
India IN Andaman Islands; Damao; Diu; Goa; Sikkim
Indonesia  ID Borneo; Irian Barat; Timor; West New Guinea
Iran IR Persia
Iraq IQ
Ireland IE Eire
Israel IL
Italy IT
Jamaica JM
Japan JP Nansil Islands; Okinawa; Shikoku; Tori Shima
Jordan JO Hashemite Kingdom; Trans-Jordan, Hashemite Kingdom
Kazakhstan KZ
Kenya KE
Kiribati KI Canton Island; Christmas Island; Enderbury Island; Fanning Island; Gilbert Islands; Ocean Island
Korea, Democratic Peoples Republic of (North Korea) KP North Korea
Korea, Republic of (South Korea) KR South Korea
Kosovo, Republic of RS
Kuwait KW
Kyrgyzstan KG
Laos LA
Latvia LV
Lebanon  LB
Lesotho LS
Liberia  LR
Libya LY Cyjrenaica ; Fezzan; Tripolitania
Liechtenstein LI
Lithuania LT
Luxembourg LU
Macao MO Macau
Macedonia, Republic of MK
Madagascar MG Sainte Marie de Madagascar
Malawi MW
Malaysia MY Johore; Kedah; Kelantan; Labuan; Malacca; Negri Sembilan; North Borneo; Pahang; Penang; Perak; Perlis; Sabah; Sarawak; Seberang Perai; Selangor; Trengganu; Wellesley, Province
Maldives MV
Mali ML
Malta MT Cumino Island; Gozo Island
Martinique MQ French West Indies
Mauritania MR
Mauritius MU Rodrigues
Mexico MX
Moldova MD
Mongolia       MN
Montenegro ME
Montserrat MS
Morocco MA
Mozambique MZ
Myanmar MM
Namibia NA
Nauru NR
Nepal NP
Netherlands NL Holland 
New Caledonia NC Alofi Island; Huan Island; Isle of Pines; Loyalty Islands
New Zealand NZ Aitutaki, Cook Islands; Avarua; Danger Islands; Hervey, Cook Islands; Manahiki; Niue; Palmerston, Avarua; Parry, Cook Islands; Penrhyn, Tongareva; Rakaanga; Rarotonga, Cook Islands; Savage Island, Niue; Suwarrow Islands; Tokelau; Tongareva
Nicaragua NI
Niger NE
Nigeria NG
Norway NO Spitzbergen
Oman OM Muscat 
Pakistan PK Balochistan
Panama PA
Papua New Guinea PG Admiralty Islands; Bismark Archipelago; Bougainville; Buka; New Britain; New Hanover; New Ireland
Paraguay PY
Peru PE
Philippines PH
Pitcairn Island PN
Poland PL
Portugal PT Azores; Madeira Islands
Qatar QA Doha; Umm Said
Reunion RE Bourbon 
Romania RO
Russia RU
Rwanda RW
Saint Helena SH Ascension
Saint Kitts and Nevis KN Nevis 
Saint Lucia LC
Saint Pierre and Miquelon PM Miquelon
Saint Vincent and the Grenadines VC Grenadines
Samoa WS Atafu; Fakaofo; Nukunonu; Savaii Island; Upolu Island
San Marino SM
Sao Tome and Principe ST
Saudi Arabia SA
Senegal SN
Serbia, Republic of RS Kosovo
Seychelles SC
Sierra Leone  SL
Singapore SG
Sint Maarten SX Netherlands Antilles
Slovak Republic (Slovakia) SK
Slovenia SI
Solomon Islands SB Santa Cruz Islands
Somalia  SO Somali Democratic Republic; Somaliland
South Africa ZA Transkei
Spain ES Alhucemas; Balearic Islands; Canary Islands; Ceuta; Chaferinas Islands; Melilla; Penon de Velez de la Gomera; Zafarani Islands
Sri Lanka LK Ceylon 
Sudan SD
Suriname SR
Swaziland SZ
Sweden SE
Switzerland CH
Syrian Arab Republic (Syria) SY
Taiwan TW Formosa; Penghu Islands; Pescadores Islands; Quemoy
Tajikistan TJ
Tanzania TZ Pemba; Zanzibar
Thailand TH
Timor-Leste Democratic Republic of TL East Timor
Togo TG
Tonga TO Friendly Islands
Trinidad and Tobago TT Tobago
Tristan da Cunha Included in Saint Helena
Tunisia TN
Turkey TR
Turkmenistan TM
Turks and Caicos Islands TC Caicos Islands
Tuvalu TV Ellice Islands
Uganda UG
Ukraine UA
United Arab Emirates AE Abu Dhabi; Ajman; Dubai; Fujairah; Ras al Kaimah; Sharja; Trucial States;Umm al Quaiwai
Uruguay UY
Uzbekistan UZ
Vanuatu VU Banks Island; New Hebrides; Torres Island
Vatican City VA
Venezuela VE
Vietnam VN
Wallis and Futuna Islands VD Futuna
Yemen YE
Zambia ZM
Zimbabwe ZW

Errors

Error Code Error Code String Error Message
101 GenericError {Error Message}
102 InternalEndiciaError Internal Endicia Error: {Error Message}
307 InvalidOriginZipCode Invalid origin ZIP Code.
308 InvalidDestinationZipCode Invalid destination ZIP Code.
404 MailClassNotSupported Mail class not supported ({Mail Class}).
405 InvalidMailClass Invalid mail class ({Mail Class}).
406 MailpieceWeightMustBePositive Mailpiece weight must be greater than zero.
407 MailpieceWeightExceedsMaximum Weight ({Weight} ounces) exceeds maximum allowed for Mail Service ({Weight} ounces).
409 InvalidMailpieceValue {Description} value is invalid.
410 MailpieceValueMustBePositive {Description} value must be greater than $0.00.
411 MailpieceValueExceedsMaximum Mailpiece value exceeds the {Amount} maximum allowed for {Insurance Type}.
412 MailpieceShapeNotSupported Mailpiece shape not supported ({Mailpiece Shape}).
413 InvalidMailpieceShape Invalid mailpiece shape ({Mailpiece Shape}).
414 ServiceLevelNotSupported Service Level not supported ({Service Level}).
415 InvalidServiceLevel Invalid Service Level ({Service Level}).
416 SortTypeNotSupported Sort Type not supported ({Sort Type}).
417 InvalidSortType Invalid Sort Type ({Sort Type}).
418 PricingNotOffered {Pricing} pricing is not offered for {Mail Service}.
420 MailServiceNotAvailableToCountry {Mail Service} is not available to {Country Name}.
421 InvalidCountry {Country} is not a valid country.
422 OnlinePostageNotAllowed Online postage is not allowed for {Mail Service} to {Country Name}.
423 LimitedMailServiceToCountry {Mail Service} to {Country Name} is limited to {allowed mail service(s)}.
430 MailpieceDimensionsMustBePositive Mailpiece length, width, and height must be greater than zero.
431 MailpieceDimensionsRequired Mailpiece dimensions are required for {Mail Class}.
434 LengthPlusGirthExceedsMaximum Mailpiece length plus girth of {Dimension}" exceeds maximum of {Dimension}" allowed by Mail Service.
436 InvalidEntryFacility Invalid Entry Facility ({Entry Facility}).
437 EntryFacilityDoesNotServiceDesination Entry Facility {Entry Facility} does not service destination ZIP code {ZIP code}.
440 DeliveryConfirmationNotAvailable Delivery Confirmation is not available for {Description}.
441 SignatureConfirmationNotAvailable Signature Confirmation is not available for {Description}.
448 InsuranceNotAvailableToCountry {Insurance Type} is not available to {Country Name}.
449 ExtraServiceNotAvailable {Extra Service} is not available for this mailpiece.
501 NoCubicPostageCalculator Cubic postage calculator is not available for {Mail Class} {Pricing} pricing.
502 CubicPricingNotOffered Cubic pricing is not offered for {Mail Class} {Pricing} pricing.
503 MailpieceCubicVolumeMustBePositive Mailpiece cubic volume must be greater than zero.
504 MailpieceCubicVolumeExceedsMaximum Cubic volume ({Volume} cu. ft.) exceeds maximum of {Volume} cu. ft. allowed for mail service.
1001 MissingOrInvalidXMLElement Missing or invalid data element: {Element Name}
1002 ElementNotAllowed Element not allowed: {Element Name}
1011 InvalidTrackingNumber Service Type Code in Tracking Number must match Services requested for the package.
1020 InvalidRecreditAmount RecreditAmount must be greater than zero and less than $100,000.
1050 NoCustomsItems Customs Info does not contain any customs items.
1051 InvalidCustomsItemData {Element Name} must be a positive numeric value {Amount} or less.
1052 TotalCustomsValueMustBePositive Total customs value must be a positive numeric value 99999.99 or less.
1053 ContentsWeightExceedsPackageWeight Total package weight must be equal to or greater than the sum of the item weights.
1054 ExceedsItemLimitForCustomsForm {Form Type} is limited to only {n} items.
1055 ExceedsValueLimitForCustomsForm Total customs value cannot exceed {Amount} for mailpiece using Customs Form {Form Type}.
1059 InvalidMailClassForOD {Mail Class} is not a valid MailClass for open and distribute service.
1061 NoServicesAllowedForOD No extra services are allowed with Open and Distribute service
1062 IncorrectWeightForOD Enclosed mail cannot be placed directly in sacks and should be placed in tray(s), if package weight is less than 5lbs
1064 ConflictingServices Conflicting services requested.
1066 SelectedServicesDoNotApply Selected services {Service 1, Service 2,…} do not apply.
1067 SignatureRequired Signature cannot be waived for Express Mail shipments when Adult Signature, COD, USPS insurance, or Hold For Pickup has been selected.
1101 AccountNotAuthorizedForLabel Account #{Account Number} is not authorized for the requested label type.
1103 MailpieceShapeNotSupportedForLiveAnimals USPS-provided packaging is not allowed when shipping live animals.
1109 Endicia Pay-On-Use Returns service is not available for this USPS service combination.
1501 ExceedsLimitForAddressLines Address lines exceed maximum allowed.
1505 MailClassNotAllowedForLabel {Mail Class} is not allowed for label.
2010 InvalidAccountStatus Account #{Account Number} has an invalid status. Please contact the Endicia Label Server Support Team.
2011 AccountNeedsPassPhraseReset Account #{Account Number} requires a Pass Phrase reset.
2012 AccountSuspendedBadLogins Account #{Account Number} has been suspended due to multiple login attempts with an incorrect Pass Phrase. Please contact Endicia customer support at (650) 321-2640 x130 or LabelServer@endicia.com.
2013 AccountSuspendedForCause Account #{Account Number} has been suspended. Please contact Endicia customer support at (650) 321-2640 x130 or LabelServer@endicia.com.
2014 AccountPendingClose Account #{Account Number} is scheduled to be closed. Please contact Endicia customer support at (650) 321-2640 x130 or LabelServer@endicia.com.
2015 AccountIsClosed Account #{Account Number} is closed. Please contact Endicia customer support at (650) 321-2640 x130 or LabelServer@endicia.com.
2020 AccountNotQualifiedForMailClass Account #{Account Number} is not qualified for {Mail Class}.
2021 AccountNotQualifiedForFeature Account #{Account Number} is not qualified for {Feature Description}.
3005 NameOrCompanyRequired {Sender’s
3010 InsuredValueExceedsEndiciaMaximum Insured value exceeds the $10,000 maximum allowed by Endicia.
3011 InsuredValueMustBePositive Insured value must be greater than $0.00.
3020 FailedValidatingShipFromAddress Unable to validate Ship From address.
3021 FailedValidatingShipToAddress Unable to validate Ship To address.
3023 ExpressMailNotAvailableToDestination Express Mail Service is not available to the destination address.
3024 ServiceNotAvailableToDestination One or more services are not available to the destination address.
3025 CustomsFormNotAllowedForMailpiece Customs Form is not allowed for mailpiece.
3027 ConsolidatorslabelsNotAllowed Requested Consolidator Label is invalid.
4001 InvalidFieldInDialAZipResponse The {Field Name} field in Dial-A-ZIP response is invalid.
11001 FailedRetrievingPICNumber Unable to retrieve PIC number: {Description}
11002 PICNumberServiceError Error returned from PIC Number Service.
11003 InvalidPICNumberReceived Invalid PIC number received: {Number}
11101 FailedRetrievingExpressMailNumber Unable to retrieve Express Mail number: {Description}
11102 ExpressMailAPIError Error returned from Express Mail API: {Description}
11110 FailedRetrievingEMCommitments Unable to retrieve Express Mail Service Commitments: {Description}
11111 NotEligibleForSundayHolidayDelivery Mailpiece not eligible for Express Mail Sunday/Holiday Delivery Service.
11112 ServiceCommitmentsNotFound There were no Express Mail Service Commitments for the mailpiece.
11113 ServiceCommitmentNotOnSundayHoliday Express Mail Sunday/Holiday Delivery Service not allowed: Service Commitment does not fall on a Sunday or a Holiday.
11114 CannotMeetServiceCommitmentCutOffTime Ship time is past the latest cut-off time to meet Express Mail Service Commitment.
11115 NoSundayHolidayDeliveryToDestination Express Mail Sunday/Holiday Delivery Service is not available to ZIP Code {Zip Code}.
11204 FailedRetrievingConfirmCode Unable to retrieve IMb confirmation code: {Description}
11301 FailedRetrievingLabelNumber Unable to retrieve {Mail Class/Extra Service} number: {Description}
11302 LabelNumberServiceError Error returned from Label Number Service: {Description}
11303 NoLabelNumberReceived Label Number Service did not return a label number.
11304 InvalidLabelNumberReceived Invalid label number received from Label Number Service: {Label Number}
11401 FailedRetrievingBarcodeNumber Unable to retrieve {Description} barcode number.
11402 InternationalLabelAPIError Error returned from International Label API: {Description}
11403 CustomsFormsAPIError Error returned from Customs Forms API: {Description}
11451 FailedRetrievingAccountInformation Unable to retrieve information for account #{Account Number}: {Description}
11452 AccountInformationServiceError Error returned from Account Information Service for account #{Account Number}: {Description}
11453 InvalidValueinAccountInformation Invalid {Value Name} value received for account #{Account Number}.
11501 FailedValidatingAddress Unable to validate address: {Description}
11502 NonDeliverableAddress The address is not a deliverable location according to the US Postal Service.
11503 UnknownDialAZipReturnCode Dial-A-ZIP Server ({Server Name}) has returned an unknown return code of {value}.
11611 DialAZipInvalidZipCode Dial-A-ZIP error: Invalid ZIP Code
11612 DialAZipInvalidStateCode Dial-A-ZIP error: Invalid state code.
11613 DialAZipInvalidCity Dial-A-ZIP error: Invalid city.
11621 DialAZipAddressNotFound Dial-A-ZIP error: Address not found.
11622 DialAZipMultipleMatchesTooAmbiguious Dial-A-ZIP error: Address is too ambiguous.
11803 DHLSortCodeLookupError Failed to retrieve DHL Sort code: {DHL sortcode API error message}.
12001 PurchaseTooSmall Buy transaction must be greater than $10.00.
12002 IndiciumValueZero Indicium value is zero.
12003 VpoTransactionFailed VPO transaction failed ({Status Codes}): {Description}
12004 VpoAdminCallFailed VPO Admin Transaction failed ({Status Codes}): {Description}
12100 UnknownPostageTransactionError The Postage Transaction has returned an unknown error.
12101 AccountNotFound The Certified Intermediary’s account number is invalid.
12103 InactiveAccount The Certified Intermediary’s account is not active.
12104 InsufficientFunds1 The Certified Intermediary’s account does not have enough postage balance to support this transaction.
12115 IndiciumMaxExceeded The indicium postage requested exceeds the account’s limit
12116 InvalidCreditCard Invalid credit card on account.
12117 InvalidCCExpiration The account credit card’s expiration date has passed
12118 InvalidPurchaseAmountLow The purchase amount is too low.
12119 InvalidPurchaseAmountHigh The purchase amount exceeds the account’s purchase limit.
12120 CreditCardFailed The credit card transaction failed.
12121 PurchaseUpdateFailed The update to the account with the credit card information failed.
12124 DatabaseFailure General database error
12125 InvalidRequest The XML Request type is not recognized
12128 InvalidCCDeclined The credit card purchase was declined by the customer’s bank.
12129 InvalidCCReferred The credit card purchase was “referred” by the customer’s bank. Contact the bank.
12130 Unavailable The Postage Server is unavailable.
12131 InvalidCCAddress The address on the credit card is invalid.
12132 CCUnavailable The credit card processing is unavailable.
12133 Locked The account is locked (possibly in use).
12134 AccountHoldFailed The request to hold the account for a transaction failed.
12135 InternetAccessFailure Internet access/communication failure.
12136 AccountIsBusy Account is busy.
12144 InvalidPartnerCustomerId PartnerCustomerID is missing or Invalid.
12201 XmlParseError The XML request cannot be parsed for all required elements. The description provides details on the problem item.
12500 KeyMacCheckFailed The key on the account has been tampered with and no transactions are allowed.
12502 NegativeDollarIndiciumRequest Indicium requests must be positive.
12503 InsufficientFunds2 There is not enough money in the account to produce the indicium.
12505 AccountMacFailed The account information has been tampered with and no transactions are allowed.
12507 IncorrectPassPhrase The Certified Intermediary’s Pass Phrase is incorrect.
12508 IncorrectEmail The email provided is incorrect.
12509 IncorrectChallengeAnswer The challenge answer provided is incorrect.
12514 ReplayDetected The system has detected a duplicate request for postage.
12515 AccountMacCheckFailed The account information has been tampered with and no transactions are allowed.
12525 AccountSuspended The account has been suspended and no transactions are allowed.
12669 PassPhraseReused The new Pass Phrase cannot match up to the four previously used Pass Phrases.
13001 ConfirmReceiptFailed Internal Error: Confirm Receipt transaction failed for label number {0}.
16000 PackagePickupAPIError Package Pickup API error: {0}
16001 FailedCancelingPackagePickup Failed Canceling Package Pickup: {0}
16002 InvalidPackagePickupConfirmation The package pickup with confirmation number {0} does not exist or has been cancelled.
22000 InvalidDHLGMProduct Invalid DHLGM International product specified in the MailClass element.
22001 DestinationCountryNotAllowed Destination country is not allowed for specified product.
22002 MaximumWeightExceeded Maximum weight exceeded for specified product.
22003 DimensionsNotSpecified Dimensions not specified in the MailpieceDimensions data element.
22004 MaximumLengthExceeded Maximum length exceeded for specified product
22005 LengthNotSpecified Length not specified in the MailpieceDimensions data element.
22006 HeightNotSpecified Height not specified in the MailpieceDimensions data element.
22007 WidthNotSpecified Width not specified in the MailpieceDimensions data element.
22008 WeightNotSpecified Weight not specified in the WeightOz data element.
22009 MaximumCombinedDimensionsExceeded Maximum combined dimensions exceeded for specified product.
22010 DestinationCountryNotSpecified Destination country not specified in the ToCountryCode data element.
22011 InvalidAccount Account credentials not specified.
22012 AccountNotEnabledForDHLGM Account not enabled for DHLGM International.
22014 MaximumCommodityValueForCountryExceeded Maximum commodity value exceeded for destination country.
22015 ElementMissing Missing data element: {0}
22016 InvalidShipDate Invalid data specified in ShipDate element
22017 InvalidWeight WeightOz data element cannot be zero.
22018 InvalidCustomsData Invalid data specified in the CustomsInfo element, or CustomsInfo not allowed for product.
22019 CustomsItemsLimitExceeded Too many customs items specified.
22020 NoCustomsItemsSpecified No customs items specified.
22021 InvalidCustomsItem Invalid customs item. Item description: {0}
22022 CustomsWeightExceedsPackageWeight The combined weight of the customs items cannot exceed the value in the WeightOz data element.
22023 DestinationCountryCodeNotFound Could not find country information for specified country code: {0}
22024 StateMissing ToState is required for destination country {0}
22025 PostalCodeMissing Postal Code is required for destination country {0}
22026 PhoneRequiredForParcelDirect ToPhone is required when using GlobalMail Parcel Direct
22027 PhoneNumberTooLong Phone Number for destination country {0} cannot exceed {1}
22028 HSTariffNumberRequired HS Tariff Number is required for each customs item for destination country {0}
22029 ItemCodeTooLong The item code for customs element with description {0} is too long. The limit is 20 characters
22030 DescriptionTooLong The customs item description is limited to 50 characters. The following description is too long {0}
22031 InvalidState The specified state {1} is invalid for specified country {0}
22032 AccountNotAuthorizedForService Account not authorized for requested service: {0}
22033 ErrorGeneratingLabel There was an error when generating the label
60002 InternalLabelServiceError Internal Endicia Label Server Web Service Error: {Error Message}
60003 InvalidSoapRequestFormat The format of the SOAP request is invalid.
60105 FailedCreatingPostageLabel Failed to create postage label.
60106 FailedCreatingCustomsForm Failed to create customs form.
60107 StampLabelNotAllowedForWebMethod A label of type Stamp cannot be created with this web method.
60108 StampRequestNotProcessed Stamp request not processed (account not charged).
60109 StampRequestNotPrinted Stamp request not printed. Account charged but postage not printable.
60110 LabelNotAllowedForOfficialMail Label is not allowed for official mail.
60111 ClientNotAuthorizedForWebMethod Client is not authorized to invoke this web method.
60112 FailedCreatingSCANForm Failed to create SCAN form.
60113 NoShipmentsAddedToSCANForm No shipments were added to the SCAN form.
60115 FailedCreatingPackagePickup Failed to create the package pickup: {0}
60116 NotEnoughShipmentsForPickup Not enough shipments for package pickup.
60118 TransactionsDateSpanTooLarge Transactions date span cannot be greater than 7 days.
60119 FailedRetrievingTransactions Failed retrieving transactions. {0}
60120 FailedRetrievingPackageStatus Failed to retrieve Package Status.
60121 FailedReadingInsuranceRate Failed to read insurance rate: {0}
60200 SCANFormNotFound SCAN form could not be found.
60201 AccountNotQualifiedForPricing Account #{Account Number} is not qualified for {Mail Class} {Pricing} pricing.
60202 AccountNotAuthorizedForWebMethod Account #{0} is not authorized to invoke this Web method.
60501 NoPostageRatesCalculated No postage rates calculated.
60502 FailedCalculatingPostageRates Error calculating postage rates for one or more mail classes: {0}
60505 FailedToCreateAccount Failed to create account. {0}
60506 ContractIdNotValid One or more Contract ID(s) are invalid.
60507 PartnerNotAllowedForZeroPostageStamps Partner - {0} is not allowed to print Zero Postage Stamps.
60508 AccountNotQualifiedForELS This account is not qualified to access Endicia Label Server. Please contact Endicia customer support at (650) 321 2640 x130 or labelserver@endicia.com.
60510 NoMailPiecesToManifest
60511 ValidationCompareDifference
60512 PhysicalAddressNotFound Physical Address Does Not Exist.
60513 MailingAddressNotFound Mailing Address Does Not Exist.
60514 CreditCardAddressNotFound Credit Card Address Does Not Exist.
60515 ContractTypeAlreadyExistsForAccount
60519 EPRCustomFormLabelNotAllowed Endicia Pay-on-Use Return labels are not available for this address
61001 MissingKeyInWebConfig Missing {0} key in web.config file.
61002 InvalidWebConfigValue Invalid value for {0} key in web.config file: {1}
61003 MissingConnectionStringSettings Missing connection string settings for {0} in web.config file.
61103 InvalidColumnInTable Invalid column {0} in {1} table at row #{2}.
61106 CountryCodeDoesNotExist The specified country code does not exist: {0}.
61110 InvalidRestrictionCodeArgument Restriction Code cannot be null or empty.
61111 InvalidRestrictionCodesArgument Restriction Codes cannot be null or empty.
61112 InvalidRestrictionCodesValue Restriction Codes is not valid: {0}
61113 RestrictionCodeDoesNotExist The specified restriction code does not exist: {0}.
61501 InvalidAccountID Account ID {0} is invalid.
61502 WeightExceedsUspsMaximum Weight must be 70 pounds (1120 ounces) or less.
61503 WeightExceedsLimitForMailService Weight is limited to {0} ounces or less for selected mail service.
61510 InvalidLabelDate Label date {0} is invalid.
61511 LabelDateOutOfRange Ship date must be within the next {0} days.
61520 DeclaredValueMustBePositive Declared Value must be greater than $0.00.
61521 DeclaredValueExceedsMaximum Declared value exceeds the {0} maximum allowed for {1}.
61530 NameOrCompanyNameRequired {0}'s name or company name is required.
61531 NoDeliveryAddressLines {0}'s address must contain at least one delivery address line.
61550 NoCustomsInfo Customs Info is required for an international mailpiece.
61552 CustomsItemsExceedLimit Customs Info cannot contain more than {0} customs items.
61554 InvalidCustomsItemQuantity {0} must be a positive numeric value 999999999 or less.
61555 InvalidCustomsItemWeight {0} must be a positive numeric value 1120 or less.
61556 InvalidCustomsItemValue {0} must be a positive numeric value 99999.99 or less.
61557 TotalCustomsValueExceedsLimit Total customs value cannot exceed {0} for {1}.
61559 InvalidNumberCounterMax Number Counter Max must be greater than 0.
61560 InvalidNumberCounter {0} doesn't exist.
61601 WeightExceedsLimitForMailServiceCountry Weight is limited to {0} ounces or less for selected mail service to destination country (Country Code: {1}).
61602 WeightExceedsLimitForContainer Weight is limited to {0} ounces or less for {1}.
61604 OnlinePostageNotAllowedToCountry Online postage is not allowed for selected mail service to destination country (Country Code: {0}).
61701 InvalidAccountIDConfirm Wrong Account ID
61703 InvalidMailType Wrong mail type
61704 InvalidFromZipCode Wrong sender ZIPCode
61705 InvalidToZipCode Wrong addressee ZIPCode
61706 InvalidWeight Weight not authorized
61801 LabelNumberRequestNotValidated {0} has not been validated.
61802 LabelNumberServiceIsBusy The Label Number Service is busy.
61803 FailedOpeningDatabaseConnection1 Failed opening database connection.
61804 FailedOpeningDatabaseConnection2 Failed opening database connection ({0}).
61805 InvalidMailerID Invalid mailer ID: {0}.
61820 DatabaseOperationTimedOut Database operation timed out in {0}.
61821 DatabaseError A database error has occured in {0} ({1}).
61901 InvalidIdentity Invalid services selected for the transaction: {0}.
61902 MailClassNotSupportedForServiceType Mail Class ({0}) cannot be used with Service Type of {1}.
61903 InvalidInputForCheckDigit Number {0} is not valid for calculating check digit.
61904 FailedBuildingLabelNumber Failed building label number for identity {0} in {1}.
61905 FailedCalculatingCheckDigit Failed calculating check digit for Sequential Package ID {0}.
61906 FailedUpdatingLabelNumberTable Failed updating {0} for label number {1} in {2}.
61907 FailedInsertingCustomsDeclarationRecord Failed adding record to Customs Declaration table for label number {0} in {1}.
61908 FailedInsertingCustomsItemRecord Failed adding record to Customs Items table for Customs Declaration ID {0}, Item Number {1} in {2}.
61909 FailedInsertingCustomsUploadRecord Failed adding record to Customs Upload table for Customs Declaration ID {0} in {1}.
61910 InvalidContentsType Invalid contents type: {0}
61911 MaxExtraServiceCodeCountExceeded The number of extra service codes exceeds what system can support.
61912 FailedInsertingChannelType Failed inserting channel type {0}.
63008 InvalidCreditCardCountryCode Invalid credit card country code
63009 InvalidCCPaymentInfo Unable to verify payment information.
63010 UnableToVerifyCCPaymentInfo Invalid payment information. Please check and try again.

© 2012-2018 Endicia. All rights reserved.