API
Inquiry - Quote
Message
Inquiry
Scope
The customer can send an Inquiry to the supplier to check material’s availability and delivery date. Also the customer can set up the substitution flag, if he wants to receives in case the material is not available possible alternatives/substitution articles.
Format
XML
Frequency
Anytime a customer wants to check availability or wants to place an order.
Message
Quote
Scope
It is the answer of the inquiry. Within a few seconds, the customer receives an answer from the supplier and can use the data for ordering or to check another material. If the customer has set up the flag substitution in the inquiry, the answer will contain possible alternatives/substitution articles.
Format
XML
Frequency
Created after each inquiry placed by customer.
Order - Order Response
Message
Order
Scope
The customer can place an order in its ERP/system and the order will be transferred electronically into supplier’s system, Supplier creates an order response that is sent back directly to customer’s ERP/system.
There are three possible order types:
- Rush
- Replenishment
- Seasonal
Check with your supplier the maximum number of items prior to place the first order.
Format
XML
Frequency
Message
Order Response
Scope
For every order send via API to the supplier, the customer receives an order response. Normally, order response contains the order confirmation and the planned delivery time. In case of error, a specific code is sent back.
These are some of the most common error/error codes
- 911 – Incorrect EAN number
- 912 – Requested delivery date invalid
- 971 – Customers order number invalid or not found
In case of errors, contact the supplier to investigate the reason.
Format
XML
Frequency
Order Status Request - Order Status
Message
Order Status Request
Scope
After placing an order, the customer can send an order status request from its ERP/system to the supplier. This process helps to check open orders and the currently planned delivery times or to synchronize customer’s ERP/system with supplier’s data – even for order which are placed by phone, fax or email.
The status of an order can be:
- Open
- In Preparation
- Back Order
- Partially Delivered
- Delivered
- Cancelled
Format
XML
Frequency
Anytime the customer wants to check the status of an order.
Message
Order Status
Scope
For each order status request placed, the customer will receive an order status in order to check at which stage the order is.
Format
XML
Frequency
Created after each order status request placed by customer.
Dispatch Advice Request - Dispatch Advice List
Message
Desadv Request
Scope
After an order is placed, the customer can make a request to obtain the delivery information, based on one or several of following criteria’s :
• Customer number
• Delivery Date
• Delivery Number
• Order Reference
• Vendor Order Number
Format
XML
Frequency
Anytime the customer wants to check the delivery information related to status of order.
Message
Desadv List
Scope
With the Pull DESADV List the customer can be informed about upcoming deliveries and the message contains all delivery details. The data can be stored on customer’s ERP/system in advance and can be used to speed-up the incoming goods process and confirmation on customer’s site. With the pull option the customer has the option to receive the DESADV anytime and has the control and flexibility of the data flow.
Format
XML
Frequency
Created after each Desadv Request.
Response Time
For API the response time is an important and critical measurement between customer/user and supplier. Data exchange needs to be fast for providing a proper and easy access to data for the users and to avoid time outs during the data transfer.
There are different ways to measure the response time. It can be the time between user’s submission of a request and receiving the response or between data leaving customer’s network and response arriving at customer’s network.
Several reasons can have an impact on the response time and can lead to delayed data exchange or even failures/time outs. Such reasons are:
- no stable Network availability on customer’s and/or supplier’s side
- no stable Internet availability
- size of data which is requested, needs to be transferred (the more data is requested, the longer response time can be)
Though the target for all involved parties is to keep the response time as quick as possible, the suppliers cannot guarantee a standardized response time for all the different processes within API. The response time is a trigger for time outs and the definition of the last should be discussed with the supplier during the project phase of the implementation of API. Especially as time outs can be different by message/process.