ONTIME API Documentatie

CALL

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

URL	https://api.asx.be/KAAI/
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
	2	prnt			*	CMP	CMP = The documents will be collected from you by our couriers ASX = The attachments will be printed immediately with us
1	webhook						This option is only needed if you wish to receive tracking automatically as soon as there is a status change. For more information on this, visit the webhook documentation
	2	functie				URL	Possible values: FTP or URL If you choose FTP, the FTP connection must be set up by our administrators
	2	url				https://www.urlnaaruwscript	only necessary if FUNCTIE = URL
	2	methode				POST	if FUNCTIE = URL => select POST or GET if FUNCTIE = XML => select XML or JSON
	2	email				your@email.be	not mandatory, but if no connection can be made with your webhook function AND this email address is set, we will send you an email with status information
1	opdracht
	2	datum			*	2025-02-05	Date this command is to be executed Format YYYY-MM-DD
	2	middag			*	AM	AM = Morning (until 12:00) PM = Afternoon (from 12:00)
	2	expres				1	1 = Express handling and billing 0= NO express treatment
	2	deadline				16:15	Hour format HH:MM REQUIRED if express = 1
	2	bestemming				GIP LO	destination for this assignment Possible values : ANDERE DOUANE BACKOFFICE LO DOUANE BACKOFFICE RO DOUANE EERSTE KANTOOR DOUANE IVK DOUANE K363 MOTO1 DOUANE LILLO MOTO3 DOUANE SPITSENSTRAAT MOTO2 DOUANE TRIWAYS GIP (ZEEBRUGGE) GIP LO GIP LO FAVV DIENST PLANTEN GIP LO FAVV DIENST VET GIP RO KAAI 468 KAAI 118 KAAI 120 APM/CSP (ZEEBRUGGE) KAAI 1213 KAAI 1227 KAAI 1241 (HAVEN ANTWERPEN) KAAI 1333 KAAI 143 WIELINGDOK (ZEEBRUGGE) KAAI 1700 KAAI 1742 KAAI 1795 FAVV PLANTENDIENST KAAI 1795 FAVV VETERINAIRE DIENST KAAI 198 FAVV KAAI 242 KAAI 311 KAAI 338 KAAI 359 ABES KAAI 364 ATO KAAI 420 KAAI 496 KAAI 502 ICO (HAVEN ZEEBRUGGE) KAAI 519 ICO (HAVEN ZEEBRUGGE) KAAI 520 - 525 (HAVEN ZEEBRUGGE) KAAI 530 WALLENIUS (HAVEN ZEEBRUGGE) KAAI 730 KAAI 740 - MEXICONATIE KAAI 869 KAAI 913 MAGAZIJN ADM MAGAZIJN AFRULOG MAGAZIJN ALPHANATIE MAGAZIJN ALTAMIRA MAGAZIJN ANTVERPIA MAGAZIJN BEVERLAND MAGAZIJN BLOKVELDEN 1548 MAGAZIJN BVC MAGAZIJN CORRAL MAGAZIJN DOCKX LOGISTICS MAGAZIJN ESA LO MAGAZIJN ESA RO MAGAZIJN EUROCENTER MAGAZIJN GCT MAGAZIJN HANDICO MAGAZIJN IDP MAGAZIJN LEXUS MAGAZIJN LOGHIDDEN CITY MAGAZIJN LOTUS MAGAZIJN LUIKNATIE MAGAZIJN POLAND MAGAZIJN POSEIDON MAGAZIJN SEA-INVEST MAGAZIJN SSC MAGAZIJN VALKENIERSNATIE MAGAZIJN VAN MOER MAGAZIJN VAN MOER RAIL MAGAZIJN VANGUARD MAGAZIJN WAAGNATIE MAGZIJN ECOCENTER - WIJNGAARDNATIE NOVA NATIE K420 ON TIME VENTILATION ZONEK1616 WAREHOUSE ON TIME K1616 WIJNGAARDNATIE 109 If you wish to retrieve destinations specific to your customer number, use the destination API : Click here.
	2	bestemming_ander				ANDERE BESTEMMING	If you have selected 'OTHER' as your destination, this field is required to note the other destination.
	2	bestemming_adres				SINT ANTONIUSWEG 9	Street + destination number
	2	bestemming_postcode				9130	Destination postal code
	2	bestemming_gemeente				Beveren	Municipality of destination
	2	bestemming_contact				naam van de persoon	Destination contact
	2	bestemming_tel				0478325678	Destination phone number (numeric)
	2	instructie			*	AFGEVEN L/V	instruction to be executed for this command Possible values : AFGEVEN L/V AFSCHRIJVEN ANDERE CONTAINER STOCKEREN CUSTOMS STOP DOCUMENT(EN) LINKEN IN TUL SYSTEEM DOCUMENTCONTROLE DOCUMENTEN AFGEVEN LOAD LOSSEN MONDELINGE VRIJGAVE NAZICHT VALIDEREN ATR VALIDEREN EUR 1 VERLUCHTEN BIJ ON TIME VERLUCHTINGSZONE K1616 VRACHTLIJST AANZUIVEREN If you wish to retrieve instructions specific to your customer number, use the instruction API : Click here.
	2	instructie_ander				ANDERE INSTRUCTIE	If you have selected 'OTHER' as the instruction, this field is mandatory to note the other instruction.
	2	eerstewerk				1	1 = YES, your order will be fulfilled within 2 hours 0= No
	2	army				0	To be indicated only if it concerns documents for handling US or Canadian army material 1 = Yes 0= No
	2	extra			*	3	0 = no additional task 1 = gas measuring 2 = perform physical verification 3 = physical verification + gas measurement
	2	extrainfo					If you have entered gas measurement and/or physical verification, one or more fields from the block below should be completed.
		3	tijdstip		*	12:00	mandatory in gas measurement AND physical verification
		3	verificateur		*	verificateur + ref. magazijn	Information on transporter, verifier + ref. warehouse mandatory in gas measurement AND physical verification
		3	gsm		(*)	0478325678	mobile phone after office hours (numeric) ONLY mandatory in case of physical verification
		3	goederen		(*)	Omschrijving van de goederen	ONLY mandatory for gas measurement
		3	inhoud		*	CONTAINER	If gas measurement is selected, only possible value = CONTAINER If only physical verification, Possible values : CONTAINER or STUKGOED
	2	containers
		3	container				if 'inhoud = CONTAINER', please list all container numbers here
			4	containernr		MSKU1234565
	2	documenten
		3	document				per document to be handled, you can add a document tag. At least 1 document required
			4	type	*	IMA	Possible values : IMA EXA T2L TRANSIT ANDER
			4	nummer	*	ABCD1234	document number
	2	opmerking				Vrije opmerking
1	annexes
	2	bijlage
		3	naam			bijlage.pdf	Name of your attachment
		3	bestand			JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU...	BASE64_encoded

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>
        <prnt>CMP</prnt>
    </verzender> 
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <bestemming>GIP LO</bestemming>
            <bestemming_ander></bestemming_ander>
            <bestemming_adres>SINT ANTONIUSWEG 9</bestemming_adres>
            <bestemming_postcode>9130</bestemming_postcode>
            <bestemming_gemeente>Beveren</bestemming_gemeente>
            <bestemming_contact>Naam van de persoon</bestemming_contact>
            <bestemming_tel>0123456789</bestemming_tel>
            <instructie>NAZICHT</instructie>
            <instructie_ander></instructie_ander>
            <eerstewerk>0</eerstewerk>
            <army>0</army>
            <extra>3</extra>
            <extrainfo>
                <tijdstip>12:00</tijdstip>
                <verificateur>info betreffende deze tag</verificateur>
                <gsm>0498124578</gsm>
                <goederen>omschrijving van de goederen</goederen>
                <inhoud>CONTAINER</inhoud>
            </extrainfo>
                <containers>
                    <container>
                        <containernr>MSKU1234565</containernr>
                    </container>
                    <container>
                        <containernr>MSKU1296565</containernr>
                    </container> 
                </containers>
            <documenten>
                <document>
                    <type>IMA</type>
                    <nummer>IMA123456</nummer>
                </document>
                <document>
                    <type>T2L</type>
                    <nummer>T2L123456</nummer>
                </document>
                <document>
                    <type>TRANSIT</type>
                    <nummer>TRANS123456</nummer>
                </document>
            </documenten>
            <opmerking>hier mag je schrijven wat je wenst</opmerking>
        </opdracht>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
    </bijlagen>
</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	ASKxxxx	The order number
		3	track	https://track.asx.be/xxxxx	Link to the online tracking page
		3	pdf	https://portal.asx.be/pdf/bestelling/?bestelling=zzzzz	Link to order form

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>KAAI opdracht succesvol aangemaakt</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>ASKxxxxx</nummer>
            <track>https://track.asx.be/xxxxx</track>
            <pdf>https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz</pdf>
        </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 QUAY assignment