FAQ
General
How do I get access to the integration platform? Contact Support to request onboarding credentials for your integration channel.
Is there a sandbox? Yes — the Dev environment is available for integration testing. Credentials for Dev and Test are provisioned automatically at the start of onboarding.
What integration channels are available? Ympact supports two channels: message queue (JSON, real-time) and SFTP (CSV, batch). The channel is chosen during onboarding and applies to all entities.
Authentication
How do I authenticate to send data?
- Message queue: Use the AWS Access Key ID and Secret Access Key provided by Ympact. See Credentials & access.
- SFTP: Use the SSH private key and username provided by Ympact.
There is no token-based authentication flow for data submission.
My messages are not being accepted. What should I check?
- Verify your AWS credentials or SFTP key are correct for the target environment
- Confirm the queue URL or SFTP host matches the environment
- Check that the payload follows the correct schema — see the entity guide for validation rules
Data Submission
What is the standard error format? See Error Handling.
Can I resend a record if it fails validation? Yes. Ympact uses the primary key to identify records. Resending with the same primary key will update the existing record (upsert). See Idempotency for details.
What if I send a Document or Process before its Shipment exists? The record may be rejected because it references a missing Shipment. Always send Shipments and Delivery Plans first, then Documents and Processes. See Order Lifecycle.