Nieuwe STAD opdracht doorsturen

CALL

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

URL https://api.asx.be/STAD/
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
  2 prnt * CMP CMP = De documenten zullen door onze koeriers bij u worden opgehaald
ASX = De bijlagen zullen onmiddellijk bij ons worden afgeprint
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 opdrachten
  2 opdracht
  3 datum * 2025-01-14 Datum dat deze opdracht moet worden uitgevoerd
Formaat YYYY-MM-DD
  3 middag * AM AM = Voormiddag (tot 12:00)
PM = Namiddag (vanaf 12:00)
  3 expres   1 1 = Express-behandeling en -facturering
0= GEEN express-behandeling
  3 deadline   16:15 Uurformaat HH:MM
VERPLICHT indien express = 1
  3 instructie * AFGEVEN BL Instructie die moet worden uitgevoerd voor deze opdracht
Mogelijke waarden :
  • AFGEVEN ATTEST / CERTIFICAAT
  • AFGEVEN BL
  • AFGEVEN LAAT VOLGEN
  • AFGEVEN PERMIS
  • AFHALEN ATTEST / CERTIFICAAT
  • AFHALEN BL
  • AFHALEN BLANCO BL
  • AFHALEN CHEQUE
  • AFHALEN LAAT VOLGEN
  • AFHALEN VERZEKERINGSPOLIS
  • AFHALEN WAIVER
  • ANTWERPEN STADSKOERIER: OPHALEN EN LEVEREN
  • LATEN APPROUVEREN BL
Indien u de instructies specifiek voor uw klantnummer wenst op te halen, gebruik de instructie-API : Klik hier
Deze API zal tevens de verplichte velden aanduiden.
  3 bestemming
  4 bedrijf * Ontime Logistics Naam van het bedrijf
Max 250 karakters
  4 contact * Jean-Claude Van Den Berghe Naam van de contactpersoon binnen dit bedrijf
Max 250 karakters
  4 adres1 * Kattendijkdok 5A Straatnaam + Huisnummer + busnummer
Max 250 karakters
  4 adres2     Eventuele tweede adresregel
Max 250 karakters
  4 postcode * 2000 Max 4 karakters
  4 gemeente * Antwerpen Max 250 karakters
  4 tel * 0471334455 Telefoonnummer ZONDER tekens
  3 detail
  4 aantal * 3 aantal documenten/colli's die moeten verwerkt worden voor deze opdracht
Numeriek veld
  4 referentie     Extra referentie van toepassing op deze opdracht
Max 250 karakters
  4 contbl1   MSKU1234658 Container nummer / BL nummer
Max 250 karakters
Verplicht bij volgende instructies :
  • AFGEVEN BL
  • AFGEVEN LAAT VOLGEN
  • AFHALEN BL
  • AFHALEN LAAT VOLGEN
  • LATEN APPROUVEREN BL
  4 contbl2     Container nummer / BL nummer
Max 250 karakters
  4 contbl3     Container nummer / BL nummer
Max 250 karakters
  4 contbl4     Container nummer / BL nummer
Max 250 karakters
  4 contbl5     Container nummer / BL nummer
Max 250 karakters
  4 contbl6     Container nummer / BL nummer
Max 250 karakters
  4 contbl7     Container nummer / BL nummer
Max 250 karakters
  4 contbl8     Container nummer / BL nummer
Max 250 karakters
  4 contbl9     Container nummer / BL nummer
Max 250 karakters
  4 contbl10     Container nummer / BL nummer
Max 250 karakters
  4 haven   Antwerpen KAAI 1759 Naam van de haven / Max 250 karakters
Verplicht bij volgende instructies :
  • AFGEVEN BL
  • AFGEVEN LAAT VOLGEN
  • AFHALEN BL
  • AFHALEN LAAT VOLGEN
  • AFHALEN WAIVER
  • LATEN APPROUVEREN BL
  4 schip   Evanna Naam van het schip / Max 250 karakters
Verplicht bij volgende instructies :
  • AFGEVEN BL
  • AFGEVEN LAAT VOLGEN
  • AFHALEN BL
  • AFHALEN LAAT VOLGEN
  • LATEN APPROUVEREN BL
  4 opmerking     Vrije opmerking voor deze opdracht
Max 250 karakters
  4 barcode   ABCDEF123456001|ABCDEF123456002|ABCDEF123456003 Optioneel kan u zelf uw barcodes meegeven.
Indien u dit wenst, moeten hier evenveel barcodes komen als het aantal dat u bij opdracht » detail » aantal invult.
De barcodes worden onderscheiden door een '|'
Met ons voorbeeld hier, zouden dat 3 barcodes moeten zijn.
Indien u geen barcodes meegeeft, maken wij zelf onze barcodes aan.
1 bijlagen
  2 bijlage
  3 naam   bijlage.pdf Naam van uw bijlage
  3 bestand   JVBERi0xLjQKJeLjz9MNCjcgMCBvYmo
KPDwKL1R5cGUvWE9iamVjdAovU...
BASE64_encoded

JSON voorbeeld met 1 bestemming

                                    
                                      
JSON voorbeeld met 2 bestemmingen

                                    
                                        

XML voorbeeld met 1 bestemming
<?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 voorbeeld met 2 bestemmingen
<?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

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.asx.be/xxxxx Link naar de online trackingpagina
3 pdf https://portal.asx.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.asx.be/xxxxx</track>
            <pdf>https://portal.asx.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>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>
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: