EDI Specifications
This section is designed for customers wishing to send and receive information from their warehouse.
The EDI module was designed for use with Vision warehousing to allows complete electronic trading with customers.
The current processes most customers offer is the exchange of electronic files between systems, the format of these is in XML format.
Whilst API is available we still have a number of customers sending XML files via email, however we will not support sending via email beyond 30/08/2025
Where to start
Sending information to the warehouse
See the following pages :
Testing Inbound EDI How to test your EDI
Inbound Specifications The specifications for the inbound files
Developer API Technical Information on connecting to the service
Receiving information from the warehouse
What you can receive from the warehouse is located on these pages Outbound Specfications
To receive this information via email you need to contact the warehouse directly.
If you wish to use the API then you need to be already sending through the API and you can simply request these through the API.
Kay Pages in this section
Header Pages |
|
|---|---|
If you are new to sending EDI or wanting to make a change then this is the first page to start from | |
Sending information to the warehouse | |
Retrieving information from the warehouse | |
Using the API, setup information for developers. |
What is on this page
Transmission to the Warehouse
API
Sending is via API (HTTP Post)
The API is a RESTful web service. Queries are passed via URLs constructed and submitted using the HTTP protocol (specifically the GET method), just like a web page. Results can be returned as XML
This has been the primary method of communicating since 1st January 2022
Transmission to the warehouse using the following is no longer available.
FTP is no longer available (31/12/2019)
EMAIL is no longer available (31/12/2024)
Legacy customers still sending on email have been informed by their warehouses that we will cease to support this completely from 31/08/2025
Transmission from the Warehouse
API
Is available to all customers who are sending information into the warehouse system using API, you simply have to make the request to the API for the output. No configuration is necessary.
You need to be sending to the warehouse to obtain API credentials.
The warehouse are able to setup multiple contacts at your organisation to receive these files through email and you can opt to receive them as either XML or CSV which both open in excel. A small amount of outputs are available in PDF format.
Some newer formats are only available through the API and some are real time information streams and as such can only work with the API.
API Credentials
These are issued to warehouse customer to allow those customer to access their accounts through the API for sending information to the warehouse and also the retrieval.
API credentials are only issued to warehouse customers during the testing of EDI stages and will be required for you to complete stage 3 testing.
Normally warehouses require you to be sending information to them in order to obtain the token, if you just intend to be taking information then the warehouse have to give authorisation for the token.
API tokens are limited to what they can retrieve, these are known as service limits Service Limits as such it will generally be one API token to one warehouse account however exceptions are made when a customer has a trading account and a reserve account and a single token can access up to two accounts but they are subject to the single API limits.
API tokens are only provided to warehouse customers when the warehouse customer makes the request through the testing mechanism or where they are wishing to only retrieve through the warehouse authorisation process. See Testing Inbound EDI | Step by Step Guide to Testing
An API token is granted to a single legal entity, which is either a limited company, or business of the same name with the same directors/owners/proprietors, because granting this token allows the token owner to access ALL of your information including confidential and business seneitive information which includes but is not limited to
stock holding
supplier information
purchase pricing of the stock
reserve customer information
Live delivery information and customer information
A full list of all information which could be retrieve is within the following section. EDI / API Output
Developer Information is held in its own section on this wiki Developer API Technical
More Information
More information is contained within the individual sections below.
Inbound Information
Outbound Information
Related content
Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.