ONTIME API Documentatie

CALL

Deze API biedt de mogelijkheid om de huidige status van uw opdracht op te halen

URL	https://api.asx.be/TRACK/
METHOD	POST

REQUEST / INPUT

Hieronder krijgt u de structuur die gehanteerd wordt als input, inclusief een illustrerend voorbeeld en meer informatie per veld.
U mag zelf de keuze maken of u de gegevens naar ons toestuurt via JSON of XML

Niveau / Veld		Verplicht	Voorbeeld	Omschrijving
1	verwerking	*	TRACK
1	gebruiker	*	info@ontime.be	Emailadres waarop de API-account werd gedefinieerd. Max 250 karakters
1	klantnr	*	1234	Dit is het klantennummer bij ON TIME Logistics. numeriek, zonder voorgaande zeroes	Voor distributie opdrachten dient u hier het klantennummer van distri te gebruiken Dit is een numeriek nummer voorafgaand met een K, bv K01234
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Paswoord van de API-account
1	omgeving	*	TEST	TEST = TEST omgeving LIVE = LIVE omgeving
1	ordernr	*	ASK01234011	Het opdrachtnummer waarvoor je de trackinggegevens wenst op te halen	Voor distributie opdrachten dient u hier het tracknr te gebruiken dat als antwoord op uw opdracht wordt gegeven. Dit is een nummer startend met DISTR of DSTRAPI
1	haltenr	(OF)	SPR123452020093000189_1	Het unieke nummer van 1 halte	ENKEL VOOR SPRINT !! Indien u trackt voor de sprintopdrachten kan u kiezen: ofwel trackt u op ordernr ofwel op haltenr

JSON voorbeeld

XML voorbeeld

<?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

Hieronder krijgt u de structuur die gehanteerd wordt als output, inclusief een illustrerend voorbeeld en meer informatie per veld.
Indien u heeft gestuurd met JSON, zal u JSON ontvangen, idem met XML

Opgelet, voor de tracking van distributie-opdrachten krijgt een ander antwoord! Bekijk het verschil via de tab json of xml

Niveau / Veld					Voorbeeld	Omschrijving
1	status				SUCCESS	Status van deze request
1	opdracht
	2	ordernr			ASK01234011	Het opdrachtnummer
	2	status
		3	code		AN	Code van de status
		3	oms		Geannuleerd	Omschrijving van de status
	2	referentie			om te testen	De referentie van deze opdracht
	2	bestemming			GIP LO 2000 Antwerpen	Het adres van de bestemming
	2	type			kaai	Het type opdracht
	2	verzending			2020-02-06	Verzendingsdatum
	2	levering			2020-02-07	Leveringsdatum
	2	pdf			https://...	Link naar het opdrachtformulier
1	tracking
	2	detail
		3	datum		2020-02-06	Datum van deze detaillijn
		3	uur		15:04	Uur van deze detaillijn
		3	status
			4	code	AN	Code van de status
			4	oms	Geannuleerd	Omschrijving van de status
		3	extra		hier meer uitleg

Niveau / Veld			Voorbeeld	Omschrijving
1	status		ERROR	Status van deze request
1	remarks
	2	remark	foutieve credentials	Oplijsting van de gevonden fouten

JSON antwoord bij SUCCES

JSON antwoord bij DISTRI/SUCCES

JSON antwoord bij ERROR

XML antwoord bij SUCCES

<?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 antwoord bij 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 antwoord bij ERROR

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

CONTROLE/TEST

Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd

Uw INPUT string

Het resultaat/antwoord:

TRACK & TRACE