Skip to main content

Send Test File

Send a synthetic test EDI file to verify routing configuration between two ECGrid trading partners.

Endpoint

POST /v2/parcels/send-test-file

Request Body

FieldTypeRequiredConstraintsDescription
ecGridIdFromintYesSender ECGrid ID for the test transmission
ecGridIdTointYesRecipient ECGrid ID for the test transmission
documentTypestringNoEDI document type to use in the test file (e.g., "850")

:::info Routing Verification This endpoint generates a valid synthetic EDI payload and injects it into the routing engine exactly as a real parcel would be processed. Use it to confirm that a new trading partner interconnect is correctly configured before going live with production data. :::

{
"ecGridIdFrom": 112233,
"ecGridIdTo": 445566,
"documentType": "850"
}

Response

Returns the parcelId (long) of the test parcel that was created and submitted.

{
"success": true,
"data": 987654399
}

Code Examples

curl -X POST "https://rest.ecgrid.io/v2/parcels/send-test-file" \
-H "X-API-Key: $ECGRID_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "ecGridIdFrom": 112233, "ecGridIdTo": 445566, "documentType": "850" }'

See Also