Get started
Four steps to a working integration
A guided path for System Integrators connecting supplier ERPs to the Ympact platform.
01
Understand the Architecture
Understand the two integration channels, the four entities, and how data flows from your ERP to Ympact.
Read the overview 02Configure Your Environment
Set up your credentials, queues, and choose your integration channel.
Configure access 03Map Your Data
Explore schemas for shipments, delivery plans, documents, and process mappings.
Browse schemas 04Validate and Go Live
Test your integration, handle errors, and move to production.
Run validation Integration channels
Pick the path that fits your supplier
Both channels target the same data model. Use the standard channel unless you have a constraint that requires the fallback.
Recommended · StandardAlternative
Message Queue
JSON payloads via FIFO queues. Real-time, ordered, and the recommended channel for all integrations.
Formatapplication/json
TransportFIFO queue
Latencyreal-time
AuthIAM credentials
SFTP
Semicolon-delimited CSV files. Batch-oriented and available as a fallback for legacy systems.
Formattext/csv (;)
TransportSFTP drop
Latencybatch · 1h
AuthSSH key
Payload examples
Inspect a payload before you send one
Each entity is a JSON object sent to a message queue, or a row in a semicolon-delimited CSV file.
{
"ympact_module": "tracking",
"entity_type": "shipment",
"po_number": "PO-2026-001",
"po_number_line": 1,
"shipment_reference_id": "SHP-001",
"shipping_date": "2026-May-15",
"quantity": 150,
"uom": "KG",
"shipping_code": "012",
"incoterms_code": "FOB",
"deleted": "N"
}Need help? Our team is here to assist you through the integration.
Our team is here to assist with onboarding, schema questions, and troubleshooting.