ONTIME API Documentatie

CALL

This API offers the ability to send a new sprint assignment to us.

URL	https://api.asx.be/SPRINT/
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			*	CREATE	A new job will be created once all the checks have been done
1	gebruiker			*	info@ontime.be	Email address on which the API account was defined. Max 250 characters
1	klantnr			*	1234	This is the customer number at ON TIMELogistics. numeric, without preceding zeroes
1	apipswd			*	c40b0c360f3d4959b53b103b25759542	Password of the API account
1	omgeving			*	TEST	TEST = TEST environment LIVE = LIVE environment
1	verzender
	2	contact		*	Ann Flecyn	Name of the person creating the order Max 250 characters
	2	email		*	info@ontime.be	Email address of the person creating the order Max 250 characters
	2	referentie		*	dit is een test	General reference that will be mentioned on the invoice Max 30 characters
	2	tel		*	0123546789	Phone number of the person creating the order WITHOUT characters
1	opdracht
	2	productnr		*	18	unique number of the product numerical value If you wish to collect the products specifically for your customer number: Click here.
	2	voertuignr		*	2	unique number of the vehicle numerical value If you wish to pick up vehicles specific to your product number: Click here.
	2	ordermail		*	info@asx.be	e-mail address to which order confirmation will be sent
	2	vrachtbrief			Vrije opmerking	remark noted on the consignment note
1	bestemmingen
	2	bestemming
		3	num	*	1	successor number, starting from 1 At least 2 destinations to enter
		3	taak	*	1	1 = COLLECT 2 = DELIVER 3 = COLLECT + DELIVER
		3	bedrijf	*	Ontime Logistics	Company name
		3	adres1	*	Kattendijkdok 5	Address line 1
		3	adres2		Oostkaai	Address line 2
		3	land	*	BE	This is the country code
		3	postcode	*	2000	postal code
		3	gemeente	*	Antwerpen	municipality
		3	tel	*	0497123456	Telephone number WITHOUT characters
		3	contact	*	Mevrouw Spitaels	Name of contact person within this company
		3	info		Vrije tekst	Additional information on this destination
		3	datum	(*)	2020-07-14	date by which the 'task' must be performed Mandatory for destination 1 Destinations are performed immediately and consecutively one after the other. Only if you want a different time, enter from destination 2 another date, from and to
		3	van	(*)	12:00	time from Mandatory for destination 1
		3	tot	(*)	16:00	time until Mandatory for destination 1
1	goederen
	2	goed
		3	aantal	*	1	volume of goods
		3	type	*	pakket	Possible values: pakket document pallet ander
		3	gewicht	*	25	Weight in KG
		3	lengte		100	Length in CM
		3	breedte		20	Width in CM
		3	hoogte		30	Height in CM
		3	info		meubelen	Description of goods
		3	ophalen	*	1	NUM of the destination to be picked up
		3	leveren	*	2	NUM of the destination to be delivered

JSON example

XML example

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>CREATE</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>1234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
    <verzender>
        <contact>Ann Flecyn</contact>
        <email>info@ontime.be</email>
        <referentie>dit is een test</referentie>
        <tel>0123456789</tel>
    </verzender> 
        <opdracht>
            <productnr>18</productnr>
            <voertuignr>2</voertuignr>
            <ordermail>info@asx.be</ordermail>
            <vrachtbrief>deze vrije opmerking komt op de vrachtbrief</vrachtbrief>
        </opdracht>
        <bestemmingen>
            <bestemming>
                <num>1</num>
                <taak>1</taak>
                <bedrijf>Ontime Logistics</bedrijf>
                <adres1>Kattendijkdok 5</adres1>
                <adres2>Oostkaai</adres2>
                <land>BE</land>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Mevrouw Spitaels</contact>
                <info>letop, de hond bijt</info>
                <datum>2020-07-14</datum>
                <van>12:00</van>
                <tot>16:00</tot>
            </bestemming>
            <bestemming>
                <num>2</num>
                <taak>2</taak>
                <bedrijf>ASX-Ibeco</bedrijf>
                <adres1>De Keizelei 239</adres1>
                <adres2></adres2>
                <land>BE</land>
                <postcode>2001</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>0497123456</tel>
                <contact>Jan Smits</contact>
                <info></info>
                <datum></datum>
                <van></van>
                <tot></tot>
            </bestemming>
        </bestemmingen>
        <goederen>
            <goed>
                <aantal>1</aantal>
                <type>pakket</type>
                <gewicht>25</gewicht>
                <lengte>100</lengte>
                <breedte>20</breedte>
                <hoogte>30</hoogte>
                <info>meubelen</info>
                <ophalen>1</ophalen>
                <leveren>2</leveren>
            </goed>
        </goederen>
</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 opdracht aangemaakt	Informative comments
1	opdrachten
	2	opdracht
		3	nummer				xxxx	The order number
		3	tracknr				GI3TMNZZFUYTSNJABCD	unique tracking number
		3	pdf				https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Link to order form
		3	track_url				https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD	link to tracking
		3	order_rates
			4	order_total_excluding_vat			29.99	total amount excluding VAT
			4	order_total_including_vat			29.99	total amount incl. VAT
			4	rates
				5	rate
					6	description	KILOMETERS	description of the cost
					6	price	28	amount of the charge
		3	haltes
			4	halte
				5	nr		SPR123452020093000197_1	unique number of the stop
				5	bedrijf		Ontime Logistics	Company name
				5	adres		Kattendijkdok 4 Oostkaai	full address
				5	postcode		2020	postal code
				5	gemeente		Antwerpen	municipality

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 werd 1 opdracht aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>195182</nummer>
            <bestelling>SPR123452020093000189</bestelling>
            <tracknr>GI3TMNZZFUYTSNJABCD</tracknr>
            <pdf>https://portal.asx.be/pdf/opdracht/?opdracht=e3173ed8a7123456789</pdf>
            <track_url>https://et.asx-ibeco.be/planning/tracktrace.php?trackingnr=GI3TMNZZFUYTSNJABCD</track_url>
            <order_rates>
                <order_total_excluding_vat>29.99</order_total_excluding_vat>
                <order_total_including_vat>29.99</order_total_including_vat>
                <rates>
                    <rate>
                        <description>KILOMETERS</description>
                        <price>28</price>
                    </rate>
                    <rate>
                        <description>BRANDSTOFTOESLAG</description>
                        <price>0.56</price>
                    </rate>
                    <rate>
                        <description>InterCompany 5%</description>
                        <price>1.43</price>
                    </rate>
                </rates>
            </order_rates>
            <haltes>
                <halte>
                        <nr>SPR123452020093000197_1</nr>
                        <bedrijf>Ontime Logistics</bedrijf>
                        <adres>Kattendijkdok 4 Oostkaai</adres>
                        <postcode>2000</postcode>
                        <gemeente>Antwerpen</gemeente>
                </halte>
                <halte>
                        <nr>SPR123452020093000197_2</nr>
                        <bedrijf>ASX-Ibeco</bedrijf>
                        <adres>straat nr</adres>
                        <postcode>1234</postcode>
                        <gemeente>Roeselare</gemeente>
                </halte>
            </haltes>
        </opdracht>
    </opdrachten>
</WebAnswer>

XML response to ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>datum kan niet in het verleden liggen</remark>
        <remark>bestemming verplicht in te vullen</remark>
        <remark>detail-aantal verplicht in te vullen</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:

Forward new SPRINT order