ONTIME API Documentatie

CALL

Cette API vous permet d'obtenir l'état actuel de votre commande.

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

REQUEST / INPUT

Vous trouverez ci-dessous la structure utilisée comme entrée, ainsi qu'un exemple illustratif et des informations complémentaires pour chaque champ.
Vous pouvez choisir de nous envoyer les données via JSON ou XML.

Niveau/champ		Obligatoire	Exemple	Description
1	verwerking	*	TRACK
1	gebruiker	*	info@ontime.be	Adresse électronique sur laquelle le compte API a été défini. 250 caractères maximum
1	klantnr	*	1234	Il s'agit du numéro de client chez ON TIME Logistics. numérique, sans zéros précédents.	Pour les commandes de distribution, utilisez ici le numéro de client de distribution. Il s'agit d'un numéro numérique précédé d'un K, par exemple K01234.
1	apipswd	*	c40b0c360f3d4959b53b103b25759542	Mot de passe du compte API
1	omgeving	*	TEST	TEST = Environnement TEST LIVE = Environnement LIVE
1	ordernr	*	ASK01234011	Le numéro du travail pour lequel vous souhaitez récupérer les données de suivi	Pour les commandes de distribution, vous devez utiliser le tracknr donné comme réponse à votre commande ici. Il s'agit d'un nombre commençant par DISTR ou DSTRAPI
1	haltenr	(OF)	SPR123452020093000189_1	Le numéro unique d'un arrêt	SEULEMENT POUR SPRINT ! !! Si vous suivez les commandes de sprint, vous pouvez choisir : soit le suivi par numéro de commande, soit le suivi par numéro d'arrêt.

Exemple JSON

Exemple XML

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

Vous trouverez ci-dessous la structure utilisée en sortie, ainsi qu'un exemple illustratif et des informations complémentaires pour chaque champ.
Si vous envoyez avec JSON, vous recevrez JSON, idem avec XML.

Attention, pour le suivi des commandes de distribution, la réponse est différente ! Voir la différence via l'onglet json ou xml

Niveau/champ					Exemple	Description
1	status				SUCCESS	Statut de cette demande
1	opdracht
	2	ordernr			ASK01234011	Le numéro de commande
	2	status
		3	code		AN	Code d'état
		3	oms		Geannuleerd	Description du statut
	2	referentie			om te testen	La référence de cette mission
	2	bestemming			GIP LO 2000 Antwerpen	Adresse de destination
	2	type			kaai	Type d'affectation
	2	verzending			2020-02-06	Date d'expiration
	2	levering			2020-02-07	Date de livraison
	2	pdf			https://...	Lien vers le formulaire d'affectation
1	tracking
	2	detail
		3	datum		2020-02-06	Date de cette ligne de détail
		3	uur		15:04	Heure de cette ligne de détail
		3	status
			4	code	AN	Code d'état
			4	oms	Geannuleerd	Description du statut
		3	extra		hier meer uitleg

Niveau/champ			Exemple	Description
1	status		ERROR	Statut de cette demande
1	remarks
	2	remark	foutieve credentials	Liste des erreurs trouvées

Réponse JSON à SUCCESS

Réponse JSON à DISTRI/SUCCES

Réponse JSON à ERROR

Réponse XML à 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>

Réponse XML à 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>

Réponse XML à ERROR

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

CONTRÔLE/TEST

Grâce à cette fonction, vous pouvez tester n'importe quelle entrée JSON ou XML.
ATTENTION : Cette fonction est TOUJOURS exécutée dans l'environnement TEST.

Votre chaîne INPUT

Le résultat/la réponse :

TRACK & TRACE