EwsLabelService

Click here for a complete list of operations.

GetTransactionsListing

Test

The test form is only available for requests from the local machine.

SOAP 1.1

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

POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "www.envmgr.com/LabelService/GetTransactionsListing"

<?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>
    <GetTransactionsListing xmlns="www.envmgr.com/LabelService">
      <GetTransactionsListingRequest>
        <RequestID>string</RequestID>
        <RequestOptions CostCenter="string" StartDateTime="string" EndDateTime="string" ShipFromZip="string" ShipToZip="string" ReferenceID="string" TransactionType="ALL or PRINTS or PURCHASES or ADJUSTMENTS or OUTSTANDING or PAYONUSE or PAYONUSERETURN" StartingTransactionID="string" RefundStatus="ALL or SUBMITTED or VALIDATED or REJECTED or REFUNDED or MANUAL" PurchaseType="ALL or MANUAL or AUTO or OVERDRAFT" />
        <PicNumbers>
          <PIC>string</PIC>
          <PIC>string</PIC>
        </PicNumbers>
        <PieceIDs>
          <PieceID>string</PieceID>
          <PieceID>string</PieceID>
        </PieceIDs>
        <TransactionIDs>
          <TransactionID>string</TransactionID>
          <TransactionID>string</TransactionID>
        </TransactionIDs>
        <CostCenters>
          <CostCenterID>string</CostCenterID>
          <CostCenterID>string</CostCenterID>
        </CostCenters>
        <IncludeTracking>string</IncludeTracking>
        <IncludeFromAddress>string</IncludeFromAddress>
        <IncludeAdjustmentDetails>string</IncludeAdjustmentDetails>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </GetTransactionsListingRequest>
    </GetTransactionsListing>
  </soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetTransactionsListingResponse xmlns="www.envmgr.com/LabelService">
      <TransactionsListingResponse StartingTransactionID="long" EndingTransactionID="long" CompleteDataSet="boolean">
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <TransactionsResults>
          <Transaction TransactionType="PRINT or PURCHASE or OUTSTANDING or PAYONUSE" TransactionDateTime="string" PostmarkDate="string" RefundStatus="string" PurchaseType="string">
            <PIC>string</PIC>
            <TransactionID>long</TransactionID>
            <PieceID>string</PieceID>
            <Amount>string</Amount>
            <Weight>string</Weight>
            <MailClass>string</MailClass>
            <ToAddress xsi:nil="true" />
            <FromAddress xsi:nil="true" />
            <CostCenter>string</CostCenter>
            <ReferenceID>string</ReferenceID>
            <RetailAccountID>string</RetailAccountID>
            <RetailAmount>string</RetailAmount>
            <ContractID>string</ContractID>
            <Status xsi:nil="true" />
            <Zone>string</Zone>
            <CubicFt>string</CubicFt>
            <RefundDetails xsi:nil="true" />
            <AdjustmentsDetails xsi:nil="true" />
            <LabelCategory>string</LabelCategory>
          </Transaction>
          <Transaction TransactionType="PRINT or PURCHASE or OUTSTANDING or PAYONUSE" TransactionDateTime="string" PostmarkDate="string" RefundStatus="string" PurchaseType="string">
            <PIC>string</PIC>
            <TransactionID>long</TransactionID>
            <PieceID>string</PieceID>
            <Amount>string</Amount>
            <Weight>string</Weight>
            <MailClass>string</MailClass>
            <ToAddress xsi:nil="true" />
            <FromAddress xsi:nil="true" />
            <CostCenter>string</CostCenter>
            <ReferenceID>string</ReferenceID>
            <RetailAccountID>string</RetailAccountID>
            <RetailAmount>string</RetailAmount>
            <ContractID>string</ContractID>
            <Status xsi:nil="true" />
            <Zone>string</Zone>
            <CubicFt>string</CubicFt>
            <RefundDetails xsi:nil="true" />
            <AdjustmentsDetails xsi:nil="true" />
            <LabelCategory>string</LabelCategory>
          </Transaction>
        </TransactionsResults>
        <ResponseOptions StartDateTime="string" EndDateTime="string" />
      </TransactionsListingResponse>
    </GetTransactionsListingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

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

POST /LabelService/EwsLabelService.asmx HTTP/1.1
Host: labelserver.endicia.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTransactionsListing xmlns="www.envmgr.com/LabelService">
      <GetTransactionsListingRequest>
        <RequestID>string</RequestID>
        <RequestOptions CostCenter="string" StartDateTime="string" EndDateTime="string" ShipFromZip="string" ShipToZip="string" ReferenceID="string" TransactionType="ALL or PRINTS or PURCHASES or ADJUSTMENTS or OUTSTANDING or PAYONUSE or PAYONUSERETURN" StartingTransactionID="string" RefundStatus="ALL or SUBMITTED or VALIDATED or REJECTED or REFUNDED or MANUAL" PurchaseType="ALL or MANUAL or AUTO or OVERDRAFT" />
        <PicNumbers>
          <PIC>string</PIC>
          <PIC>string</PIC>
        </PicNumbers>
        <PieceIDs>
          <PieceID>string</PieceID>
          <PieceID>string</PieceID>
        </PieceIDs>
        <TransactionIDs>
          <TransactionID>string</TransactionID>
          <TransactionID>string</TransactionID>
        </TransactionIDs>
        <CostCenters>
          <CostCenterID>string</CostCenterID>
          <CostCenterID>string</CostCenterID>
        </CostCenters>
        <IncludeTracking>string</IncludeTracking>
        <IncludeFromAddress>string</IncludeFromAddress>
        <IncludeAdjustmentDetails>string</IncludeAdjustmentDetails>
        <RequesterID>string</RequesterID>
        <CertifiedIntermediary>
          <AccountID>string</AccountID>
          <PassPhrase>string</PassPhrase>
          <Token>string</Token>
          <TokenTimeStamp>string</TokenTimeStamp>
        </CertifiedIntermediary>
      </GetTransactionsListingRequest>
    </GetTransactionsListing>
  </soap12:Body>
</soap12:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetTransactionsListingResponse xmlns="www.envmgr.com/LabelService">
      <TransactionsListingResponse StartingTransactionID="long" EndingTransactionID="long" CompleteDataSet="boolean">
        <Status>int</Status>
        <ErrorMessage>string</ErrorMessage>
        <RequesterID>string</RequesterID>
        <RequestID>string</RequestID>
        <TransactionsResults>
          <Transaction TransactionType="PRINT or PURCHASE or OUTSTANDING or PAYONUSE" TransactionDateTime="string" PostmarkDate="string" RefundStatus="string" PurchaseType="string">
            <PIC>string</PIC>
            <TransactionID>long</TransactionID>
            <PieceID>string</PieceID>
            <Amount>string</Amount>
            <Weight>string</Weight>
            <MailClass>string</MailClass>
            <ToAddress xsi:nil="true" />
            <FromAddress xsi:nil="true" />
            <CostCenter>string</CostCenter>
            <ReferenceID>string</ReferenceID>
            <RetailAccountID>string</RetailAccountID>
            <RetailAmount>string</RetailAmount>
            <ContractID>string</ContractID>
            <Status xsi:nil="true" />
            <Zone>string</Zone>
            <CubicFt>string</CubicFt>
            <RefundDetails xsi:nil="true" />
            <AdjustmentsDetails xsi:nil="true" />
            <LabelCategory>string</LabelCategory>
          </Transaction>
          <Transaction TransactionType="PRINT or PURCHASE or OUTSTANDING or PAYONUSE" TransactionDateTime="string" PostmarkDate="string" RefundStatus="string" PurchaseType="string">
            <PIC>string</PIC>
            <TransactionID>long</TransactionID>
            <PieceID>string</PieceID>
            <Amount>string</Amount>
            <Weight>string</Weight>
            <MailClass>string</MailClass>
            <ToAddress xsi:nil="true" />
            <FromAddress xsi:nil="true" />
            <CostCenter>string</CostCenter>
            <ReferenceID>string</ReferenceID>
            <RetailAccountID>string</RetailAccountID>
            <RetailAmount>string</RetailAmount>
            <ContractID>string</ContractID>
            <Status xsi:nil="true" />
            <Zone>string</Zone>
            <CubicFt>string</CubicFt>
            <RefundDetails xsi:nil="true" />
            <AdjustmentsDetails xsi:nil="true" />
            <LabelCategory>string</LabelCategory>
          </Transaction>
        </TransactionsResults>
        <ResponseOptions StartDateTime="string" EndDateTime="string" />
      </TransactionsListingResponse>
    </GetTransactionsListingResponse>
  </soap12:Body>
</soap12:Envelope>