This API offers the possibility to send a new national or international assignment to us.
| URL | https://api.asx.be/INTNAT/ |
|---|---|
| METHOD | POST |
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 | * | 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 | |||
| 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 | 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-01-14 | date this command is to be executed Format YYYY-MM-DD |
|||
| 2 | inhoud | * | BRIEF | Possible values: BRIEF or PAKKET | |||
| 2 | oms | * | verschillende brieven | description of the goods to be collected | |||
| 2 | tijdstip | Enter the time when the shipment is ready for collection | |||||
| 3 | van | 10:00 | hour from | ||||
| 3 | tot | 17:00 | hour to | ||||
| 2 | brief | only to be completed if content = BRIEF | |||||
| 3 | aantal | * | 7 | number of letters | |||
| 3 | gewicht | * | 3.0 | The weight in KG of the total shipment | |||
| 2 | pakketten | only to be completed if content = PAKKET | |||||
| 3 | pakket | ||||||
| 4 | aantal | * | 1 | number of packages with these dimensions | |||
| 4 | gewicht | * | 0.5 | Weight in KG | |||
| 4 | lengte | * | 29 | Length in CM | |||
| 4 | breedte | * | 29 | Width in CM | |||
| 4 | hoogte | * | 3 | Height in CM | |||
| 2 | ophaling | ||||||
| 3 | bedrijf | * | Ontime Logistics | Company name Max 250 characters |
|||
| 3 | adres1 | * | Kattendijkdok 5A | Street name + House number + bus number Max 250 characters |
|||
| 3 | adres2 | Possible second address line Max 250 characters |
|||||
| 3 | postcode | * | 2000 | Max 4 characters | |||
| 3 | gemeente | * | Antwerpen | Max 250 characters | |||
| 3 | tel | * | 0471334455 | Telephone number WITHOUT characters | |||
| 3 | contact | * | Mevr. Spitaels | Name of contact person within this company | |||
| 2 | bestemming | ||||||
| 3 | bedrijf | * | Ontime Logistics | Company name Max 250 characters |
|||
| 3 | adres1 | * | Kattendijkdok 5A | Street name + House number + bus number Max 250 characters |
|||
| 3 | adres2 | Possible second address line Max 250 characters |
|||||
| 3 | postcode | * | 2000 | Max 4 characters | |||
| 3 | gemeente | * | Antwerpen | Max 250 characters | |||
| 3 | land | BE | This is the country code BE = Belgium, NL = Netherlands, FR = France, ... If empty, the 'default' is taken = BE (Belgium) |
||||
| 3 | tel | * | 0471334455 | Telephone number WITHOUT characters | |||
| 3 | contact | * | Mevr. Spitaels | Name of contact person within this company | |||
<?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> <opdracht> <datum>2020-01-27</datum> <inhoud>PAKKET</inhoud> <oms>verschillende pakketten</oms> <tijdstip> <van>10:00</van> <tot>17:00</tot> </tijdstip> <pakketten> <pakket> <aantal>1</aantal> <gewicht>35</gewicht> <lengte>29</lengte> <breedte>29</breedte> <hoogte>3</hoogte> </pakket> <pakket> <aantal>5</aantal> <gewicht>25.66</gewicht> <lengte>10</lengte> <breedte>10</breedte> <hoogte>10</hoogte> </pakket> </pakketten> <ophaling> <contact>Mevr. Spitaels</contact> <adres1>Kattendijkdok 5A</adres1> <adres2></adres2> <postcode>2000</postcode> <gemeente>Antwerpen</gemeente> <tel>963214785</tel> </ophaling> <bestemming> <bedrijf>Ontime Logistics</bedrijf> <contact>Jean-Claude Van Den Berghe</contact> <adres1>Kattendijkdok 5A</adres1> <adres2></adres2> <postcode>2000</postcode> <gemeente>Antwerpen</gemeente> <land>BE</land> <tel>963214785</tel> </bestemming> </opdracht> </WebOrder>
<?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> <opdracht> <datum>2020-01-27</datum> <inhoud>BRIEF</inhoud> <oms>verschillende brieven</oms> <tijdstip> <van>10:00</van> <tot>17:00</tot> </tijdstip> <brief> <aantal>3</aantal> <gewicht>0.5</gewicht> </brief> <ophaling> <contact>Mevr. Spitaels</contact> <adres1>Kattendijkdok 5A</adres1> <adres2></adres2> <postcode>2000</postcode> <gemeente>Antwerpen</gemeente> <tel>963214785</tel> </ophaling> <bestemming> <bedrijf>Ontime Logistics</bedrijf> <contact>Jean-Claude Van Den Berghe</contact> <adres1>Kattendijkdok 5A</adres1> <adres2></adres2> <postcode>2000</postcode> <gemeente>Antwerpen</gemeente> <land>BE</land> <tel>963214785</tel> </bestemming> </opdracht> </WebOrder>
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 | ASSxxxx | The order number | ||||
| 3 | track | https://track.asx.be/xxxxx | Link to the online tracking page | ||||
| 3 | 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 | ||||
<?xml version="1.0" encoding="utf-8"?> <WebAnswer> <status>SUCCESS</status> <remarks> <remark>Er werd 1 nationale opdracht aangemaakt </remark> </remarks> <opdrachten> <opdracht> <nummer>ASXxxxxx</nummer> <track>https://track.asx.be/xxxxx</track> <pdf>https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz</pdf> </instructie> </instructies> </WebAnswer>
<?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> </remarks> </WebAnswer>
Through this function, you can try out any JSON or XML input.
ATTENTION : This function is ALWAYS performed in the TEST environment