EDI data service

Retrieves the EDI mail item details imported into IPS via EMSEVT.

Access to this method is authorized by the Get EDI data operation.

You can use the API method in one of two ways.

Retrieve by mail item ID

If only a mail item ID is specified, all mail items with this ID will be returned. All events for the given mail item are returned (no matter when they were received)

Retrieve by mail item characteristics

Specify the origin country, destination country, from GMT date-time, to GMT date-time. Only the from GMT date-time parameter is mandatory.

For each mail item with an event captured within the specified time interval, the mail item will be returned in the response. Only events for the mail item which were captured within the time interval will be included.

If the country parameters are specified then the results will be filtered to only return data where the mail item matches the specified parameters.

If the combination of supplied parameters, or their values, is incorrect, then HTTP response 400 (Bad Request) is returned.

Retrieves the EDI mail dispatch, receptacle and mail item details imported into IPS via PREDES and RESDES messages.

Access to this method is authorized by the Get EDI data operation.

Retrieves the EDI mail item details imported into IPS via EMSEVT.

You can use the API method in one of two ways.

Retrieve by dispatch ID

If only a dispatch ID is specified, messages for all dispatches with this ID will be returned (no matter when they were received).

Retrieve by dispatch characteristics

Specify the operator, mail flow, from GMT date-time, to GMT date-time. Only the from GMT date-time parameter is mandatory.

• All pre-advised dispatch data (for the specified operator and mail flow) received in the specified time interval will be returned.
• If the partner operator is specified and the mailflow is I, the API searches for EDI messages relating to inbound dispatches. The operator of the origin office must equal the specified parameter.
• If the partner operator is specified and mailflow is O, the API searches for EDI messages relating to outbound dispatches. The operator of the destination office must equal the specified parameter.
• If the mailflow is I with no partner operator specified, the API returns all inbound dispatches. The operator of the destination office is your own operator.
• If mailflow is O with no partner operator specified, the API returns all outbound dispatches. The operator of the origin office is your own operator.
• If the partner operator is specified with no mailflow the API returns all dispatches exchanged with the specified partner. The operator of the destination office is your own operator or the operator of the origin office is your own operator.

If the combination of specified parameters, or their values, is incorrect, then HTTP response 400 (Bad Request) is returned with error code 2.

Parameter CreateEDIDupOthers affects the storage of EDI dispatches and EDI receptacles. The default for this parameter is false. Multiple PREDES messages for the same dispatch will be stored in the same EDI dispatch (with multiple events).

Retrieves the EDI consignment, dispatch and receptacle details imported into IPS via PRECON, RESCON, CARDIT and RESDIT messages.

Access to this method is authorized by the Get EDI data operation.

You can use the API method in one of two ways.

Retrieve by consignment ID

If only a consignment ID is specified, messages for all consignments with this ID will be returned (no matter when they were received).

Retrieve by consignment characteristics

Specify the operator, mail flow, from GMT date-time, to GMT date-time. Only the from GMT date-time parameter is mandatory.

• All pre-advised consignment data (for the specified operator and mail flow) received in the specified time interval will be returned.
• If the partner operator and mailflow are specified, the API filters the results to only return data matching the specified parameters.
• If the partner operator is specified and the mailflow is I, the API searches for EDI messages relating to outbound consignments. The operator of the destination office must equal the specified parameter.
• If the partner operator is specified and the mailflow is O, the API searches for EDI messages relating to outbound consignments. The operator of the destination office must equal the specified parameter.
• If the partner operator is specified and mailflow is O, the API searches for EDI messages relating to outbound dispatches. The operator of the destination office must equal the specified parameter.
• If the mailflow is I with no partner operator specified, the API returns all inbound consignments. The operator of the destination office is your own operator.
• If mailflow is O with no partner operator specified, the API returns all outbound consignments. The operator of the origin office is your own operator.
• If the partner operator is specified with no mailflow the API returns all consignments exchanged with the specified partner. The operator of the destination office is your own operator or the operator of the origin office is your own operator.

If the combination of specified parameters, or their values, is incorrect, then HTTP response 400 (Bad Request) is returned with error code 2.

Parameter CreateEDIDupOthers affects the storage of EDI consignments and EDI receptacles. The default for this parameter is false. Multiple PRECON messages for the same dispatch will be stored in the same EDI dispatch (with multiple events).