This API offers the ability to send a new CITY, DISTRI or SPRINT to us.
URL | https://api.asx.be/COMBO/ |
---|---|
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 | service | * | CITY | CITY, DISTRI or SPRINT | |||
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 | ophalen | ||||||
2 | datum | 2025-02-05 | Date that this command should be RETRIEVED Format YYYY-MM-DD If you do not enter this date, this order will be executed as soon as possible |
||||
2 | uur | 16:15 | Hour format HH:MM Only to be completed if there is a deadline |
||||
2 | bedrijf | * | Ontime Logistics | Company name Max 250 characters |
|||
2 | contact | * | Jean-Claude Van Den Berghe | Name of contact person within this company Max 250 characters |
|||
2 | adres1 | * | Kattendijkdok 5A | Street name + House number + bus number Max 250 characters |
|||
2 | adres2 | Possible second address line Max 250 characters |
|||||
2 | postcode | * | 2000 | Max 4 characters | |||
2 | gemeente | * | Antwerpen | Max 250 characters | |||
2 | tel | * | 0471334455 | Telephone number WITHOUT characters | |||
2 | land | BE |
If not filled in = BE Only BE, NL, LU possible! NL and LU only possible for the DISTRI service |
||||
1 | leveren | ||||||
2 | datum | 2025-02-05 | Date that this order must be DELIVERED Format YYYY-MM-DD If you do not enter this date, this order will be executed as soon as possible |
||||
2 | uur | 16:15 | Hour format HH:MM Only to be completed if there is a deadline |
||||
2 | bedrijf | * | Ontime Logistics | Company name Max 250 characters |
|||
2 | contact | * | Jean-Claude Van Den Berghe | Name of contact person within this company Max 250 characters |
|||
2 | adres1 | * | Kattendijkdok 5A | Street name + House number + bus number Max 250 characters |
|||
2 | adres2 | Possible second address line Max 250 characters |
|||||
2 | postcode | * | 2000 | Max 4 characters | |||
2 | gemeente | * | Antwerpen | Max 250 characters | |||
2 | tel | * | 0471334455 | Telephone number WITHOUT characters | |||
2 | land | BE |
If not filled in = BE Only BE, NL, LU possible! NL and LU only possible for the DISTRI service |
||||
1 | goederen | ||||||
2 | goed | ||||||
3 | aantal | * | 7 | Aantal documenten/colli's die moeten verwerkt worden voor deze opdracht Numeric field |
|||
3 | type | * | PAKKET | PACKAGE or LETTER | |||
3 | gewicht | * | 1.25 | Weight in KG Use decimal POINT |
|||
3 | breedte | (*) | 7 | Width in CM (*) ONLY if type = PACKAGE Use decimal POINT |
|||
3 | hoogte | (*) | 7 | Height in CM (*) ONLY if type = PACKAGE Use decimal POINT |
|||
3 | lengte | (*) | 7 | Length in CM (*) ONLY if type = PACKAGE Use decimal POINT |
|||
3 | oms | Description | Description of goods |
CREATE info@ontime.be 1234 c40b0c360f3d4959b53b103b25759542 TEST CITY Ann Flecyn info@ontime.be dit is een test 0123456789 2020-01-27 16:15 Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 963214785 2020-01-27 16:15 Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 963214785 1 PAKKET 1.25 0.5 0.5 0.5 omschrijving van de goederen
CREATE info@ontime.be 1234 c40b0c360f3d4959b53b103b25759542 TEST CITY Ann Flecyn info@ontime.be dit is een test 0123456789 2020-01-27 16:15 Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 963214785 2020-01-27 16:15 Ontime Logistics Jean-Claude Van Den Berghe Kattendijkdok 5A 2000 Antwerpen 963214785 1 PAKKET 1.25 0.5 0.5 0.5 omschrijving van de goederen 2 BRIEF 1.25 0 0 0 omschrijving van de goederen
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 | 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 |
SUCCESS Er werd een stadsopdracht aangemaakt ASDxxxxx https://portal.asx.be/pdf/bestelling/?bestelling=zzzzzzz
ERROR opdracht - datum kan niet in het verleden liggen opdracht - bestemming-bedrijf verplicht in te vullen
Through this function, you can try out any JSON or XML input.
ATTENTION : This function is ALWAYS performed in the TEST environment