ParcelInBox

List parcels in the inbound queue for a mailbox, with optional filtering by trading partner, status, and date range.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

ArrayOfParcelIDInfo ParcelInBox(string SessionID, int NetworkID, int MailboxID,
    int ECGridIDFrom, int ECGridIDTo, ParcelStatus Status,
    datetime BeginDate, datetime EndDate, short PageNo, short RecordsPerPage)

Parameters

Parameter	Type	Required	Description
SessionID	string	Yes	Active session token from Login()
NetworkID	int	Yes	Network ID; use 0 for the session default
MailboxID	int	Yes	Mailbox ID; use 0 for the session default
ECGridIDFrom	int	No	Filter by sender ECGrid ID; use 0 for all
ECGridIDTo	int	No	Filter by recipient ECGrid ID; use 0 for all
Status	ParcelStatus	Yes	Parcel status filter (see ENUMs below)
BeginDate	datetime	Yes	Start of the date range (UTC)
EndDate	datetime	Yes	End of the date range (UTC)
PageNo	short	Yes	1-based page number for paginated results
RecordsPerPage	short	Yes	Number of records per page (max 500)

Response Object — ArrayOfParcelIDInfo

Returns an array of ParcelIDInfo objects.

Field	Type	Description
ParcelID	long	Unique parcel identifier
NetworkID	int	Network that owns the parcel
MailboxID	int	Mailbox that received the parcel
FileName	string	Original file name of the parcel
Bytes	int	File size in bytes
Status	ParcelStatus	Current parcel status
ECGridIDFrom	int	Sender ECGrid ID
ECGridIDTo	int	Recipient ECGrid ID
Created	datetime	Timestamp when the parcel was created (UTC)

<!-- Example response XML -->
<ArrayOfParcelIDInfo>
  <ParcelIDInfo>
    <ParcelID>9876543</ParcelID>
    <NetworkID>1</NetworkID>
    <MailboxID>101</MailboxID>
    <FileName>invoice_20260507.edi</FileName>
    <Bytes>4096</Bytes>
    <Status>InBoxReady</Status>
    <ECGridIDFrom>123456</ECGridIDFrom>
    <ECGridIDTo>654321</ECGridIDTo>
    <Created>2026-05-07T08:00:00Z</Created>
  </ParcelIDInfo>
</ArrayOfParcelIDInfo>

Variants

ParcelInBoxEx

Extends ParcelInBox with an additional filter on the EDI mailbag control ID (ISA13).

ArrayOfParcelIDInfo ParcelInBoxEx(string SessionID, int NetworkID, int MailboxID,
    int ECGridIDFrom, int ECGridIDTo, string MailbagControlID, ParcelStatus Status,
    datetime BeginDate, datetime EndDate, short PageNo, short RecordsPerPage)

Additional Parameter	Type	Description
MailbagControlID	string	ISA13 interchange control number to match; pass empty string to skip

ParcelInBoxArchive

Searches the parcel archive using a separate date range, allowing retrieval of older delivered parcels beyond the standard inbox retention window.

ArrayOfParcelIDInfo ParcelInBoxArchive(string SessionID, int NetworkID, int MailboxID,
    int ECGridIDFrom, int ECGridIDTo, ParcelStatus Status,
    datetime BeginDate, datetime EndDate, short PageNo, short RecordsPerPage)

The parameter set is identical to ParcelInBox; the method targets the archive data store rather than the live inbox queue.

ENUMs

ParcelStatus

Value	Description
InBoxReady	Parcel is available for download
InBoxTransferred	Parcel has been downloaded and confirmed
as2Receive	Parcel received via AS2
as2Sent	Parcel sent via AS2
ftpReceived	Parcel received via FTP
ftpSent	Parcel delivered via FTP
outboxDeliveryError	Outbound delivery failed

See Appendix — ENUMs for the complete ParcelStatus value list.

Code Examples

C#

// .NET 10 — dotnet-svcutil generated proxy
// Retrieve the first page of ready inbound parcels for today
using var client = new ECGridOSPortTypeClient();

var begin = DateTime.UtcNow.Date;
var end   = begin.AddDays(1).AddSeconds(-1);

var parcels = await client.ParcelInBoxAsync(
    sessionID,
    networkID:       0,
    mailboxID:       0,
    eCGridIDFrom:    0,
    eCGridIDTo:      0,
    status:          ParcelStatus.InBoxReady,
    beginDate:       begin,
    endDate:         end,
    pageNo:          1,
    recordsPerPage:  100);

foreach (var parcel in parcels)
{
    Console.WriteLine($"ParcelID={parcel.ParcelID}  File={parcel.FileName}  Bytes={parcel.Bytes}");
}

Java

// JAX-WS generated client
// wsimport -s src https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL

ECGridOS service = new ECGridOS();
ECGridOSPortType port = service.getECGridOSPort();

var result = port.ParcelInBox(sessionID /*, additional params */);
System.out.println(result);

Node.js

// npm install soap
import soap from 'soap';

const WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL';
const client = await soap.createClientAsync(WSDL);

const [result] = await client.ParcelInBoxAsync({
  SessionID: sessionId,
  // additional params
});
console.log(result);

Python

# pip install zeep
from zeep import Client

WSDL = 'https://os.ecgrid.io/v4.1/prod/ECGridOS.asmx?WSDL'
client = Client(WSDL)

result = client.service.ParcelInBox(
    SessionID=session_id,
    # additional params
)
print(result)

REST Equivalent

See Parcel Inbox List.