ONTIME API Documentatie

CALL

This API offers the possibility to send a new city assignment to us.

URL	https://api.asx.be/STAD/
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	opdrachten
	2	opdracht
		3	datum		*	2025-02-05	Date this command is to be executed Format YYYY-MM-DD
		3	middag		*	AM	AM = Morning (until 12:00) PM = Afternoon (from 12:00)
		3	expres			1	1 = Express handling and billing 0= NO express treatment
		3	deadline			16:15	Hour format HH:MM REQUIRED if express = 1
		3	instructie		*	AFGEVEN BL	Instruction to be carried out for this task Possible values : ANTWERP CITY COURIER: PICK-UP AND DELIVERY COLLECT WAIVER DELIVERY PERMIS HAND OVER BL HAND OVER DELIVERY ORDER HAVE APPROUVE BL ISSUING OF ATTESTATION / CERTIFICATE PICK UP CERTIFICATE PICK UP B/L PICK UP BLANK B/L PICK UP CHECK PICK UP INSURANCE POLICY PICK UP RELEASE NOTE If you wish to retrieve instructions specific to your customer number, use the instruction API : Click here This API will also indicate the mandatory fields.
		3	bestemming
			4	bedrijf	*	Ontime Logistics	Company name Max 250 characters
			4	contact	*	Jean-Claude Van Den Berghe	Name of contact person within this company Max 250 characters
			4	adres1	*	Kattendijkdok 5A	Street name + House number + bus number Max 250 characters
			4	adres2			Possible second address line Max 250 characters
			4	postcode	*	2000	Max 4 characters
			4	gemeente	*	Antwerpen	Max 250 characters
			4	tel	*	0471334455	Telephone number WITHOUT characters
		3	detail
			4	aantal	*	3	Aantal documenten/colli's die moeten verwerkt worden voor deze opdracht Numeric field
			4	referentie			Additional reference applicable to this assignment Max 250 characters
			4	contbl1		MSKU1234658	Container number / BL number Max 250 characters Mandatory for following instructions : HAND OVER BL HAND OVER DELIVERY ORDER HAVE APPROUVE BL PICK UP B/L PICK UP RELEASE NOTE
			4	contbl2			Container number / BL number Max 250 characters
			4	contbl3			Container number / BL number Max 250 characters
			4	contbl4			Container number / BL number Max 250 characters
			4	contbl5			Container number / BL number Max 250 characters
			4	contbl6			Container number / BL number Max 250 characters
			4	contbl7			Container number / BL number Max 250 characters
			4	contbl8			Container number / BL number Max 250 characters
			4	contbl9			Container number / BL number Max 250 characters
			4	contbl10			Container number / BL number Max 250 characters
			4	haven		Antwerpen KAAI 1759	Port name / Max 250 characters Mandatory for following instructions : COLLECT WAIVER HAND OVER BL HAND OVER DELIVERY ORDER HAVE APPROUVE BL PICK UP B/L PICK UP RELEASE NOTE
			4	schip		Evanna	Name of ship / Max 250 characters Mandatory for following instructions : HAND OVER BL HAND OVER DELIVERY ORDER HAVE APPROUVE BL PICK UP B/L PICK UP RELEASE NOTE
			4	opmerking			Free note for this assignment Max 250 characters
			4	barcode		ABCDEF123456001\|ABCDEF123456002\|ABCDEF123456003	Optionally, you can include your own barcodes. If you wish, there should be as many barcodes here as the number you enter at product The barcodes are distinguished by a '\|' With our example here, that should be 3 barcodes. If you do not provide barcodes, we will create our own barcodes.
1	bijlagen
	2	bijlage
		3	naam			bijlage.pdf	Name of your attachment
		3	bestand			JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo KPDwKL1R5cGUvWE9iamVjdAovU...	BASE64_encoded

JSON example with 1 destination

JSON example with 2 destinations

XML example with 1 destination

<?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> 
    <opdrachten>
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <bedrijf>Ontime Logistics</bedrijf>
                <contact>Jean-Claude Van Den Berghe</contact>
                <adres1>Kattendijkdok 5A</adres1>
                <adres2></adres2>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>963214785</tel>
            </bestemming>
            <detail>
                <aantal>3</aantal>
                <referentie>testje</referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
    </opdrachten>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
    </bijlagen>
</WebOrder>

XML example with 2 destinations

<?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> 
    <opdrachten>
        <opdracht>
            <datum>2020-01-27</datum>
            <middag>AM</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <bedrijf>Ontime Logistics</bedrijf>
                <contact>Jean-Claude Van Den Berghe</contact>
                <adres1>Kattendijkdok 5A</adres1>
                <adres2></adres2>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>741258963</tel>
            </bestemming>
            <detail>
                <aantal>5</aantal>
                <referentie></referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
        <opdracht>
            <datum>Bob Dylan</datum>
            <middag>USA</middag>
            <expres>1</expres>
            <deadline>16:15</deadline>
            <instructie>AFGEVEN BL</instructie>
            <bestemming>
                <bedrijf>Ontime Logistics 2</bedrijf>
                <contact>Jean-Claude Van Den Berghe</contact>
                <adres1>Kattendijkdok 5A</adres1>
                <adres2></adres2>
                <postcode>2000</postcode>
                <gemeente>Antwerpen</gemeente>
                <tel>987456321</tel>
            </bestemming>
            <detail>
                <aantal>7</aantal>
                <referentie>ref</referentie>
                <contbl1>CONTBL voorbeeld</contbl1>
                <contbl2></contbl2>
                <haven>Antwerpen KAAI 1759</haven>
                <schip>Evanna</schip>
                <opmerking></opmerking>
                <handtekening>0</handtekening>
                <betaling></betaling>
                <bedrag></bedrag>
                <munt></munt>
                <chequenr></chequenr>
            </detail>
        </opdracht>
    </opdrachten>
    <bijlagen>
        <bijlage>
            <naam>Bijlage.pdf</naam>
            <bestand>JVBERi0xLjQKJeLjz9MNCjcgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU...</bestand>
        </bijlage>
        <bijlage>
            <naam>Bijlage2.jpg</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	ASXxxxx	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>Er werd een DUBBELE stadsopdracht aangemaakt met 3 subopdrachten</remark>
    </remarks>
    <opdrachten>
        <opdracht>
            <nummer>ASDxxxxx</nummer>
            <track>https://track.asx.be/xxxxx</track>
            <pdf>https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz</pdf>
        </instructie>
    </instructies>
</WebAnswer>

XML response to ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>opdracht 1 - datum kan niet in het verleden liggen</remark>
        <remark>opdracht 2 - bestemming-bedrijf verplicht in te vullen</remark>
        <remark>opdracht 3 - detail-aantal verplicht in te vullen</remark>
        <remark>opdracht 3 - detail-contbl1 verplicht in te vullen bij deze instructie</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 CITY assignment