ONTIME DATA Documentatie

CALL

This API allows you to always retrieve the active, possible products for your company/customer number.

URL	https://api.ontime.be/DISTRI/
METHOD	POST

REQUEST / INPUT

Below is the structure used as input, including an illustrative example and more information for each field.
You may choose whether to send the data to us via JSON or XML

Level/Field		Mandatory	Example	Description
1	verwerking	*	PRODUCT	an overview of all possible products for your customer number is retrieved.
1	gebruiker	*	info@ontime.be	Email address on which the API account was defined. Max 250 characters
1	klantnr	*	K01234	This is the DISTRI customer number at ON TIMELogistics. Numeric, preceding with a 'K'
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Password of the API account
1	omgeving	*	TEST	TEST = TEST environment LIVE = LIVE environment

JSON example

XML example

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>PRODUCT</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>K01234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
</WebOrder>

RESPONSE / OUTPUT

Below is the structure used as output, including an illustrative example and more information for each field.
If you sent with JSON, you will receive JSON, idem with XML

Level/Field				Example	Description
1	status			SUCCESS
1	remarks
	2	remark		Er werd 1 productn gevonden	Informative comments
1	producten
	2	product
		3	verpakking	BLOKPAL
		3	Description	BLOKPALLET max 300kg - 1.2 - 0 - 300	You use this description when creating distribution orders under 'goods'
		3	volume	1.2	default = volume
		3	gewicht	300	default = gewicht
		3	lengte	0	default = lengte
		3	ItemID	ItemID-123456	OF (ipv de omschrijving) kan je ook dit id meegeven bij de creatie van een order in het veld 'goed » product'

Level/Field			Example	Description
1	status		ERROR
1	remarks
	2	remark	foutieve credentials	List of errors found

JSON response at SUCCESS

JSON response to ERROR

XML response at SUCCESS

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <remarks>
        <remark>er werden 3 producten gevonden</remark>
    </remarks>
    <producten>
        <product>
            <verpakking>BLOKPAL</verpakking>
            <omschrijving>BLOKPALLET max 300kg - 1.2 - 0 - 300</omschrijving>
            <volume>1.2</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>300</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
        <product>
            <verpakking>COLLI</verpakking>
            <omschrijving>COLLI 30-60kg - 0.4 - 0 - 60</omschrijving>
            <volume>0.4</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>60</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
        <product>
            <verpakking>COLLI</verpakking>
            <omschrijving>colli (50-60kg) - 0.4 - 0 - 60</omschrijving>
            <volume>0.4</volume>
            <volume_aanpassen>1</volume_aanpassen>
            <gewicht>60</gewicht>
            <gewicht_aanpassen>1</gewicht_aanpassen>
            <lengte>0</lengte>
            <lengte_aanpassen>1</lengte_aanpassen>
        </product>
    </producten>
</WebAnswer>

XML response to ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>foutieve credentials</remark>
    </remarks>
</WebAnswer>

CONTROL/TEST

Through this function, you can try out any JSON or XML input.
ATTENTION : This function is ALWAYS performed in the TEST environment

Your INPUT string

The result/response:

Collecting DISTRI products