ONTIME API Documentatie

CALL

This API provides the ability to retrieve the current status of your order

URL	https://api.asx.be/TRACK/
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	*	TRACK
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	For distribution orders, use the distri customer number here This is a numeric number preceded by a K, e.g. K01234
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Password of the API account
1	omgeving	*	TEST	TEST = TEST environment LIVE = LIVE environment
1	ordernr	*	ASK01234011	The job number for which you wish to retrieve the tracking data	For distribution orders, you should use the tracknr given as the answer to your order here. This is a number starting with DISTR or DSTRAPI
1	haltenr	(OF)	SPR123452020093000189_1	The unique number of 1 stop	ONLY FOR SPRINT !!! If you track for sprint orders, you can choose: either track by order no. or by stop no.

JSON example

XML example

<?xml version="1.0" encoding="utf-8"?>
<WebOrder> 
    <verwerking>TRACK</verwerking>
    <gebruiker>info@ontime.be</gebruiker>
    <klantnr>1234</klantnr>
    <apipswd>c40b0c360f3d4959b53b103b25759542</apipswd>
    <omgeving>TEST</omgeving>
    <ordernr>ASK01234011</ordernr>
</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

Attention, for tracking distribution commands gets a different answer! See the difference via the json or xml tab

Level/Field					Example	Description
1	status				SUCCESS	Status of this request
1	opdracht
	2	ordernr			ASK01234011	The order number
	2	status
		3	code		AN	Status code
		3	oms		Geannuleerd	Description of status
	2	referentie			om te testen	The reference of this assignment
	2	bestemming			GIP LO 2000 Antwerpen	Destination address
	2	type			kaai	Assignment type
	2	verzending			2020-02-06	Shipping date
	2	levering			2020-02-07	Delivery date
	2	pdf			https://...	Link to assignment form
1	tracking
	2	detail
		3	datum		2020-02-06	Date of this detail line
		3	uur		15:04	Hour of this detail line
		3	status
			4	code	AN	Status code
			4	oms	Geannuleerd	Description of status
		3	extra		hier meer uitleg

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

JSON response at SUCCESS

JSON response at DISTRI/SUCCES

JSON response to ERROR

XML response at SUCCESS

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <opdracht>
        <ordernr>ASK01234011</ordernr>
        <status>
            <code>AN</code>
            <oms>Geanuleerd</oms>
        </status>
        <referentie>om te testen</referentie>
        <bestemming>GIP LO 2000 Antwerpen</bestemming>
        <type>kaai</type>
        <verzending>2020-02-06</verzending>
        <levering>2020-02-07</levering>
        <pdf>https://...</pdf>
    </opdracht>
    <tracking>
        <detail>
            <datum>2020-02-06</datum>
            <uur>15:04</uur>
            <status>
               <code>AN</code>
               <oms>Geanuleerd</oms>
            </status>
            <extra>hier meer uitleg</extra>
        </detail>
        <detail>
            <datum>2020-02-06</datum>
            <uur>15:04</uur>
            <status>
               <code>AN</code>
               <oms>Geanuleerd</oms>
            </status>
            <extra>hier meer uitleg</extra>
        </detail>
    </tracking>
</WebAnswer>

XML response at DISTRI/SUCCES

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>SUCCESS</status>
    <opdracht>
        <ordernr>123465</ordernr>
        <status>
            <code>030</code>
            <oms>FINISHED</oms>
        </status>
        <referentie>om te testen</referentie>
        <bestemming>On Time Logistics</bestemming>
        <type>distri</type>
        <pdf>https://...</pdf>
    </opdracht>
    <detail>
        <ophaling>
            <datum>2020-02-06</datum>
            <uur>15:04</uur>
            <status>FINISHED</status>
            <code>250</code>
            <oms></oms>
        </ophaling>
        <levering>
            <datum>2020-02-06</datum>
            <uur>15:04</uur>
            <status>FINISHED</status>
            <code>201</code>
            <oms>PERFECTE LEV./GEEN REMBOURS</oms>
        </levering>
    </detail>
</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:

TRACK & TRACE