Skip to main content

EDI communication

The EDI route allows the transmission of some standardized electronic interchange files, independently from the other Retail operations classes.

EDI methods​

Import​

Adds a new EDI message to the Importation queue. The importation process is managed later by a dedicated external process.

Method​

POST/api/externals/v1/edi

Arguments​

  • messageType (string): EDI message type based on EANCom standards (e.g. “OSTRPT”, “ORDRSP”, …)
  • subscriptionNumber (long): EDI message subscription number
  • subscriptionConfirmNumber (long): EDI message confirmation number

Body​

The EDI file to process, zipped and directly passed as an array of bytes.

Response​

{
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}