ONTIME DATA Documentatie

CALL

Deze API biedt de mogelijkheid aan om een nieuwe warehouse opdracht naar ons toe te sturen.

URL	https://api.asx.be/WAREHOUSE/
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			*	CREATE		Er zal een nieuwe opdracht worden aangemaakt zodra alle controles zijn gebeurd
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
1	apipswd			*	c40b0c360f3d4959b53b103b25759542		Paswoord van de API-account
1	omgeving			*	TEST		TEST = TEST omgeving LIVE = LIVE omgeving
1	verzender
	2	contact		*	Ann Flecyn		Naam van de persoon die de opdracht aanmaakt Max 250 karakters
	2	email		*	info@ontime.be		Emailadres van de persoon die de opdracht aanmaakt Max 250 karakters
	2	referentie		*	dit is een test		Algemene referentie die zal vermeld worden op het factuur Max 30 karakters
	2	tel		*	0123546789		Telefoonnummer van de persoon die de opdracht aanmaakt ZONDER tekens
1	webhook						Deze optie is enkel nodig indien u de tracking automatisch wenst te ontvangen zodra er een status-verandering is. Voor meer informatie hierover, ga naar de webhook-documentatie
	2	functie			URL		Mogelijke waarden: FTP of URL Indien u kiest voor FTP dient de FTP-connectie ingesteld te worden door onze beheerders
	2	url			https://www.urlnaaruwscript		enkel noodzakelijk indien FUNCTIE = URL
	2	methode			POST		indien FUNCTIE = URL => kies POST of GET indien FUNCTIE = XML => kies XML of JSON
	2	email			your@email.be		niet verplicht, maar indien er geen connectie kan gemaakt worden met uw webhookfunctie EN dit emailadres is ingesteld, sturen wij u een mail met de status-informatie
1	Bestemming
	2	bedrijf		*		Ontime Logistics	Naam van het bedrijf Max 250 karakters
	2	adres1		*		Kattendijkdok	Straat + nr van de bestemming Max 250 karakters
	2	adres2					Eventuele tweede adresregel Max 250 karakters
	2	postcode		*		2000	Max 4 karakters
	2	gemeente		*		Antwerpen	Max 250 karakters
	2	tel		*		0471334455	Telefoonnummer ZONDER tekens
	2	land				BE	Indien niet ingevuld = BE
	2	contact		*		Jean-Claude Van Den Berghe	Naam van de contactpersoon binnen dit bedrijf Max 250 karakters
1	producten
	2	product
		3	aantal	*	3		aantal goederen Numeriek veld
		3	productid	*	WH-12345		Gebruik hier de 'omschrijving' van het product zoals gekend bij distributie. Indien u de producten specifiek voor uw klantnummer wenst op te halen, gebruik de producten-API : Klik hier.

<?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>
    </verzender> 
    <bestemming>
        <bedrijf>Ontime Logistics</bedrijf>
        <adres1>Kattendijkdok 5</adres1>
        <adres2></adres2>
        <postcode>2000</postcode>
        <gemeente>Antwerpen</gemeente>
        <tel>0123456789</tel>
        <land>BE</land>
        <contact>Jean-Claude Van Den Berghe</contact>
    </bestemming> 
    <producten>
        <product>
            <aantal>3</aantal>
            <productid>WH-12345</productid>
        </product>
        <product>
            <aantal>1</aantal>
            <productid>WH-TEST</productid>
        </product>
    </producten>
</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

Niveau / Veld				Voorbeeld	Omschrijving
1	status			SUCCESS
1	remarks
	2	remark		Er werd 1 opdracht aangemaakt	Informatieve opmerkingen
1	opdrachten
	2	opdracht
		3	nummer	ASXxxxx	Het opdrachtnummer
		3	track	https://track.ontime.be/xxxxx	Link naar de online trackingpagina
		3	pdf	https://portal.ontime.be/pdf/bestelling/?bestelling=zzzzz	Link naar het bestelformulier

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

JSON antwoord bij SUCCES

JSON antwoord bij ERROR

XML antwoord bij SUCCES

<?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.ontime.be/xxxxx</track>
            <pdf>https://portal.ontime.be/pdf/bestelling/?bestelling=zzzzzzz</pdf>
        </instructie>
    </instructies>
</WebAnswer>

XML antwoord bij ERROR

<?xml version="1.0" encoding="utf-8"?>
<WebAnswer> 
    <status>ERROR</status>
    <remarks>
        <remark>datum kan niet in het verleden liggen</remark>
        <remark>bestemming-bedrijf verplicht in te vullen</remark>
        <remark>product-aantal verplicht in te vullen</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:

Nieuwe WAREHOUSE opdracht doorsturen