Overview

Web services enable the automated and cross-system exchange of business data via standardized web protocols. They are typically based on technologies such as HTTP/HTTPS, SOAP, or REST and allow direct communication between applications. Using web services, systems can exchange, process, and integrate data in real time, without manual intervention or delayed transfer processes.

Key features of web services:

• Standardized communication via web protocols such as HTTP or HTTPS.
• Automated data exchange between applications and systems.
• Support for various data formats, for example XML or JSON.
• Real-time data transmission, allowing information to be processed immediately.
• Flexible integration into existing IT systems such as ERP, inventory management, or logistics systems.
• Secure data transmission through encryption and authentication mechanisms (e.g., TLS, API keys, or certificates).
• High scalability and extensibility, allowing new partners or systems to be easily integrated.

Supported message types (TYPES):

• ORDERS – Order
• ORDRSP – Order response (order confirmation)
• ORDRCHG – Order change
• DESADV – Despatch advice (delivery note)
• RECADV – Receiving advice
• INVOIC – Invoice
• INVRPT – Inventory report
• DELFOR – Delivery forecast (delivery schedule)
• IFTMIN – Transport instruction
• PRODAT – Product data
• APERAK – Application error and acknowledgement message
• REMADV – Remittance advice
• SORDERS – Collective order
• HANMOV – Handling and storage movement

Sending data to us

File Names:
Alphanumeric characters (a-z, A-Z, 0-9)
Allowed special characters: “-“, “.”, “_”, “~”

Field description:
The individual fields have the following meaning:

• name
  File name of the transmitted file.
  Used to identify the file within the system and must be unique for each file.
• type
  Message type (EDI type) describing the content of the file.
  Examples:
  • ORDERS
  • INVOIC
  • DESADV
• content
  Content of the file.
  The original file must be converted into a Base64 string before transmission.

{
"name": "22a2ac8f-9bb3-4938-9425-31079a5fa9bc",
"type": "ORDERS",
"content": "dGhlIGNvbnRlbnQgbXVzdCBiZSBiYXNlNjQgZW5jb2RlZA=="
}

curl -L \ -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \ https://bridge.test.service.avenum.com/v1 \ -d '{"type":"ORDERS","content":"dGhlIGNvbnRlbnQgbXVzdCBiZSBiYXNlNjQgZW5jb2RlZA=="}'

Fetch data from us

curl -L \
-X POST \
-H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
https://bridge.test.service.avenum.com/v1/out/INVOIC

[
{
"name": "test-1"
"type": "INVOIC",
},
{
"name": "test-2"
"type": "INVOIC",
} 
]

Fetch file content

GET /out/${type}/${name}

Returns the file with the specified type and name.

{
"name": "Name der Datei", "type": "Typ der Datei", "content": "Inhalt der Datei (Base64 encoded)"


}

200 OK = Everything worked correctly
403 Forbidden = No permission or invalid credentials
404 Not found = The requested content could not be found

Delete file

DELETE /out/${type}/${name}

Deletes the file with the specified type and name.

Important: Retrieved files are not deleted automatically. The file must be actively deleted after successful processing.

204 No content = Successfully processed
403 Forbidden = No permission or invalid credentials
404 Not found = The requested content could not be found