Deze API biedt de mogelijkheid aan om een nieuwe distributieopdracht naar ons toe te sturen.
URL | https://api.asx.be/DISTRI/ |
---|---|
METHOD | POST |
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 | * | K01234 | Dit is het DISTRI klantennummer bij ON TIME Logistics. Numeriek, voorafgaand met een 'K' |
|||
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 | * | 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 | 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 | opdracht | ||||||
2 | rembours_bedrag | 123.45 | Rembours bedrag (indien nodig) | ||||
2 | rembours_munt | EUR | Rebours munteenheid. Indien u de munteenheden specifiek voor uw klantnummer wenst op te halen, gebruik de currencies-API : Klik hier. |
||||
2 | neutraal | * | 0 | Indien het gaat over een neutrale levering, gebruik '1' EN vul het neutraal adres in. Anders '0' |
|||
1 | ophalen | ||||||
2 | datum | 2025-01-14 | datum dat deze opdracht moet worden OPGEHAALD Formaat YYYY-MM-DD Indien u deze datum niet invult, zal deze opdracht zo snel mogelijk worden uitgevoerd |
||||
2 | bedrijf | * | Ontime Logistics | Naam van het bedrijf Max 250 karakters |
|||
2 | contact | * | Jean-Claude Van Den Berghe | Naam van de contactpersoon binnen dit bedrijf Max 250 karakters |
|||
2 | straat | * | Kattendijkdok | Straatnaam Max 250 karakters |
|||
2 | huisnr | * | 5A | Huisnummer + busnummer | |||
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 Indien u de landen specifiek voor uw klantnummer wenst op te halen, gebruik de landen-API : Klik hier. |
||||
2 | info_chauffeur | Hier kan u extra info meegeven voor de chauffeur | |||||
2 | uren | ||||||
3 | maandag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op MAANDAG: Vanaf voormiddag - tot voormiddag - vanaf namiddag - tot namiddag Formaat : hh:mm-hh:mm-hh:mm-hh:mm Indien u dit niet invult, wordt de default genomen :09:00-12:00-13:00-17:00 |
||||
3 | dinsdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op DINSDAG | ||||
3 | woensdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op WOENSDAG | ||||
3 | donderdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op DONDERDAG | ||||
3 | vrijdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op VRIJDAG | ||||
3 | zaterdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit ophaaladres op ZATERDAG | ||||
2 | confirm_load | ann@test.be; jan@test.com |
Indien u eerst bevestiging wenst voor de ophaling vooraleer de opdracht wordt uitgevoerd, vul hier het e-mailadres in waar de vraag voor bevestiging naartoe moet worden gestuurd De opdracht zal pas worden uitgevoerd ZODRA er bevestigd wordt. Meerdere e-mails mogelijk, gescheiden door ; |
||||
1 | leveren | ||||||
2 | datum | 2025-01-14 | Datum dat deze opdracht moet worden GELEVERD Formaat YYYY-MM-DD Indien u deze datum niet invult, zal deze opdracht zo snel mogelijk worden uitgevoerd |
||||
2 | bedrijf | * | Ontime Logistics | Naam van het bedrijf Max 250 karakters |
|||
2 | contact | * | Jean-Claude Van Den Berghe | Naam van de contactpersoon binnen dit bedrijf Max 250 karakters |
|||
2 | straat | * | Kattendijkdok | Straatnaam Max 250 karakters |
|||
2 | huisnr | * | 5A | Huisnummer + busnummer | |||
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 Indien u de landen specifiek voor uw klantnummer wenst op te halen, gebruik de landen-API : Klik hier. |
||||
2 | info_chauffeur | Hier kan u extra info meegeven voor de chauffeur | |||||
2 | track_email | Indien u hier een geldig emailadres invult, zal dit emailadres worden gebruikt om de nodige 'updates' naar toe te sturen | |||||
2 | uren | ||||||
3 | maandag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op MAANDAG: Vanaf voormiddag - tot voormiddag - vanaf namiddag - tot namiddag Formaat : hh:mm-hh:mm-hh:mm-hh:mm Indien u dit niet invult, wordt de default genomen :09:00-12:00-13:00-17:00 |
||||
3 | dinsdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op DINSDAG | ||||
3 | woensdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op WOENSDAG | ||||
3 | donderdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op DONDERDAG | ||||
3 | vrijdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op VRIJDAG | ||||
3 | zaterdag | 09:00-12:00-13:00-17:00 | Vul hierin de openingsuren van dit leveringsadres op ZATERDAG | ||||
1 | neutraal | Verplicht in te vullen indien opdracht->neutraal = 1 | |||||
2 | bedrijf | Naam van het bedrijf Max 250 karakters |
|||||
2 | contact | Naam van de contactpersoon binnen dit bedrijf Max 250 karakters |
|||||
2 | straat | Straatnaam Max 250 karakters |
|||||
2 | huisnr | Huisnummer + busnummer | |||||
2 | adres2 | Eventuele tweede adresregel Max 250 karakters |
|||||
2 | postcode | Max 4 karakters | |||||
2 | gemeente | Max 250 karakters | |||||
2 | tel | Telefoonnummer ZONDER tekens | |||||
2 | land |
Indien niet ingevuld = BE Indien u de landen specifiek voor uw klantnummer wenst op te halen, gebruik de landen-API : Klik hier. |
|||||
1 | goederen | ||||||
2 | goed | ||||||
3 | product | * | COLLI 30-60kg - 0.4 - 0 - 60 | 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. |
|||
3 | aantal | * | 3 | aantal documenten/colli's die moeten verwerkt worden voor deze opdracht Numeriek veld |
|||
3 | volume | 0.4 | Indien via de producten-API 'volume_aanpassen' op 1 staat kan u hier het volume ingeven. Indien u niks mee geeft, zullen de 'default' waarden worden gebruikt Voor colli en lengtegoederen: lengte x breedte x hoogte in meter. Voor palletgoederen: invullen per ingenomen palletplaatsen (1m³ = 1 euro-palletplaats met grondvlak 1.20m x 0.80m). |
||||
3 | gewicht | 60 | Indien via de producten-API 'gewicht_aanpassen' op 1 staat kan u hier het gewicht ingeven. Indien u niks mee geeft, zullen de 'default' waarden worden gebruikt |
||||
3 | lengte | 5 | Indien via de producten-API 'lengte_aanpassen' op 1 staat kan u hier de lengte ingeven. Indien u niks mee geeft, zullen de 'default' waarden worden gebruikt Bij goederen langer dan 1.5 meter: steeds lengte invullen in meter. Zo plannen wij uw zending op het aangepaste voertuig. |
||||
3 | 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 goed » 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. |
CREATE info@ontime.be K01234 c40b0c360f3d4959b53b103b25759542 TEST Jean-Claude Van Den Berghe info@ontime.be dit is een test 123456798 0 2020-01-07 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE opgepast voor de hond 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 09:00-12:00-00:00-00:00 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 00:00-00:00-00:00-00:00 2020-01-07 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE opgepast voor de hond naam@bedrijf.com 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 09:00-12:00-00:00-00:00 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 00:00-00:00-00:00-00:00 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE COLLI 30-60kg - 0.4 - 0 - 60 7 50 5 5
CREATE info@ontime.be K01234 c40b0c360f3d4959b53b103b25759542 TEST Jean-Claude Van Den Berghe info@ontime.be dit is een test 123456798 0 2020-01-07 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE opgepast voor de hond 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 09:00-12:00-00:00-00:00 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 00:00-00:00-00:00-00:00 2020-01-07 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE opgepast voor de hond naam@bedrijf.com 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 09:00-12:00-00:00-00:00 09:00-12:00-13:00-17:00 09:00-12:00-13:00-17:00 00:00-00:00-00:00-00:00 Ontime Logistics Jean-Claude Van Den Berghe 963214785 Kattendijkdok 5A 2000 Antwerpen BE COLLI 30-60kg - 0.4 - 0 - 60 7 50 5 5 TEST 3 ABCDEF123456001|ABCDEF123456002|ABCDEF123456003
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 | xxxxxxx | Het opdrachtnummer | ||||
3 | track | https://track.asx.be/xxxxx | Link naar de online trackingpagina | ||||
3 | tracknr | DSTRAPIxxxxx | Het unieke trackingnummer. Dit nummer kan u gebruiken in onze online functie https://track.asx.be of in de tracking API |
||||
3 | https://portal.asx.be/pdf/bestelling/?bestel=DSTRAPIxxxxx | Link naar het bestelformulier | |||||
3 | label | https://portal.asx.be/pdf/bestelling/?etiket=DSTRAPIxxxxx | Link naar de labels |
Niveau / Veld | Voorbeeld | Omschrijving | |||||
---|---|---|---|---|---|---|---|
1 | status | ERROR | |||||
1 | remarks | ||||||
2 | remark | foutieve credentials | Oplijsting van de gevonden fouten |
SUCCESS Er werd 1 opdracht aangemaakt xxxxx DSTRAPIxxxxx https://portal.asx.be/pdf/bestelling/?bestel=DSTRAPIxxxxx
ERROR datum kan niet in het verleden liggen bedrijf verplicht in te vullen aantal verplicht in te vullen
Via deze functie kan u elke JSON of XML input uitproberen.
OPGELET : Deze functie wordt STEEDS in de TEST omgeving uitgevoerd