If you wish to receive automatic statuses of your orders, you can use our webhook function.
You can choose from 2 functions:
by URL | via FTP |
---|---|
Method: GET or POST
URL: the url to which we should send the status X-API-KEY: (optional) if we need to access your url with an X-API-KEY, we also need it |
Method: JSON or XML
HOST: host name, e.g. ftp.yourcompany.be or the IP address GEBRUIKERSNAAM: username to connect to your host PASWOORD: password to connect to your host |
E-mail:: You can (optionally) provide us with an e-mail address which we will address as soon as a webhook connection failed (e.g. connection problem, server down, ...). This way, you will be informed of the statuses that have not reached you. |
How to set your webhook settings:
via API commands | through our administration team |
---|---|
In this API documentation, you can find how to set up your webhook for each command via the webhook fields (marked in this colour), i.e. you provide your webhook settings PER command.. ATTENTION: the fields indicated in red above still need to be set by our administration team. |
You can have statuses for ALL commands coming from API, PORTAL, XLS, ... have the statuses sent to your webhook.
For this, you need to contact our team with your chosen options, click here We set up your webhook and statuses will be sent via your chosen function and method |
The URL/GET method is the simplest method, which only sends the basic data to you.
We send to your webhook url with the (blue) fields below
Below is an example:
https://www.uwurl.be?order=ASS123456789&barcode=ABC123&container=MSKU123&status=PROCESSING&statustime=20230717094743&statuscode=take&statusNL=Mee+met+koerier&statusEN=Taken+by+courier&statusFR=En+route+avec+courier&referentie=
These are the fields we include:
The URL/POST method sends along all possible values
We send to your webhook URL in JSON format
Below is an example:
{"order":"ASK132456798", "barcode":"", "container":"", "status":"PROCESSING", "statustime":"20230719110649", "statuscode":"take", "statusNL":"Mee met koerier", "statusEN":"Taken by courier", "statusFR":"En route avec courier", "referentie":"anc/20221588", "comment":"TAKE on: 2023-07-19 Time: 10:33:04 Scan by PRISCILLA RAES GSM: +32 494508051 Status: MK Mee Kaai GPS: lat 51.234535 - lon 4.410024", "oldlead":"", "newlead":"", "verifier":"", "signatures":[], "pictures":[]}
These are the fields we include:
The FTP/JSON method creates a json file and places it in your ftp location
The name of this file is as follows:
order_statuscode_statustime.json
example: ASK132456798_PICKUP_PLANNED_20230718095503.json
These are the fields we include:
The FTP/XML method creates an xml file and places it in your ftp location
The name of this file is as follows:
order_statuscode_statustime.xml
example: ASK132456798_PICKUP_PLANNED_20230718095503.xml
These are the fields we include:
PROCESSING | The order is in processing |
---|---|
DELIVERED | The job was finished/delivered |
CANCELLED | The order was cancelled |
WARNING | A problem has occurred, but the order will continue to be processed after some action from our team |
NOTOK | A problem occurred, preventing further processing of the order |
status | statuscode | statusNL | statusFR | statusEN |
---|---|---|---|---|
NOTOK | ADDRESS_INVALID | Adres onjuist | Adresse incorrecte | Address invalid |
DELIVERED | AF | Afgewerkt | Fini | Finished |
DELIVERED | AF (AFGEWERKT) | Afgewerkt | Fini | Finished |
CANCELLED | AN | Geannuleerd | Annulé | Canceled |
CANCELLED | AN_OPS | Geannuleerd tijdens oper. proces | Annulé en cours de route | Canceled during oper. proces |
CANCELLED | AN_OPS_COST | Geannuleerd tijdens oper. proces | Annulé en cours de route | Canceled during oper. proces |
CANCELLED | AN_OPS_FIN | Geannuleerd tijdens oper. proces | Annulé en cours de route | Canceled during oper. proces |
CANCELLED | AN_OPS_FIN (ANNULATIE OPS + FIN) | Geannuleerd tijdens oper. proces | Annulé en cours de route | Canceled during oper. proces |
CANCELLED | AN_OPS_FIN (ANNULATIE OPS + FIN)_cancel_no_mail | Geannuleerd tijdens oper. proces | Annulé en cours de route | Canceled during oper. proces |
PROCESSING | AT_CUSTOMS | Bij Douane | A la douane | At Customs |
PROCESSING | AT_SORTING_CENTRE | Aangekomen in sorteercentrum | Arrivé dans centre de triage | Arrived in sorting centre |
PROCESSING | bill_BC | Betaald via Bankkaart | Payé par Carte Banquaire | Paid by Bank Card |
PROCESSING | bill_CA | Cash betaald | Payé cash | Paid Cash |
PROCESSING | bill_TR | Betaald via overschrijving | Payé par virement | Paid by Bank Transfer |
PROCESSING | centerscan | Centerscan | Centerscan | Centerscan |
PROCESSING | CENTER_SCAN | Centerscan | Centerscan | Centerscan |
PROCESSING | D1 (DEEL 1 AFGEWERKT) | Deel 1 afgewerkt | Part 1 fini | Part 1 finished |
DELIVERED | DELIVERED | Geleverd | Livré | Delivered |
DELIVERED | delivery | Geleverd | Livré | Delivered |
DELIVERED | DELIVERY | Geleverd | Livré | Delivered |
CANCELLED | DELIVERY_AN | Annulatie | Annulation | Cancelation |
NOTOK | DELIVERY_ATTEMPT_FAILED | Leveringspoging mislukt | Échec de la tentative de livraison | Delivery attempt failed |
NOTOK | DELIVERY_DELAYED | Levering vertraagd | Délai de livraison | Delivery delayed |
PROCESSING | depotIn | Ter Behandeling Gegeven | Livré pour traitement | Delivered for processing |
PROCESSING | depotOut | Na behandeling Opgehaald | Enlevé après traitement | Picked up after processing |
PROCESSING | DEPOT_OUT | Uit voor levering | En route pour livraison | Out for delivery |
PROCESSING | DRIVER_EN_ROUTE | Op weg voor levering | En route pour livraison | Out for delivery |
WARNING | exceptionNonStack | Scan Niet Stapelbaar | Scan Non Empilable | Scan Non Stackable |
WARNING | exceptionSize | Scan Oversize | Scan Surplus Largeur | Scan Oversize |
WARNING | exceptionWeight | Scan Overgewicht | Scan Surpoids | Scan Overweight |
DELIVERED | finished | Afgewerkt | Fini | Finished |
WARNING | IE | Info klant | Information client | Information Customer |
PROCESSING | INFO_ORDER_NATINT_change_dim | Aanpassing dimensies na controle | Changements des dimensions après controle | Dimension change after check |
NOTOK | notOk_1 | ANDERE DOOR KOERIER IN TE VULLEN | AUTRE À COMPLÉTER PAR LE COURRIER | OTHER TO BE COMPLETED BY COURIER |
NOTOK | notOk_10 | NIET THUIS | Pas present | Not home |
NOTOK | notOk_100 | GEEN DOCUMENT OP KAAI | PAS DE DOCUMENT SUR LE QUAI | NO DOCUMENT ON QUAY |
NOTOK | notOk_110 | DOCUMENT NIET GETEKEND | DOCUMENT NON SIGNÉ | DOCUMENT NOT SIGNED |
NOTOK | notOk_120 | CERTIFICAAT NODIG | CERTIFICAT REQUIS | CERTIFICATE REQUIRED |
NOTOK | notOk_13 | GESLOTEN | FERMÉ | CLOSED |
NOTOK | notOk_130 | BORG KOMT RETOUR | LE DÉPÔT EST RESTITUÉ | DEPOSIT IS RETURNED |
NOTOK | notOk_140 | VERKEERDE TARIEFPOST | POSITION TARIFAIRE ERRONÉE | WRONG TARIFF HEADING |
NOTOK | notOk_16 | VERHUISD | DÉPLACÉ | MOVED |
NOTOK | notOk_160 | CONTAINER ONBEKEND | CONTENEUR INCONNU | CONTAINER UNKNOWN |
NOTOK | notOk_17 | GEEN GELD | PAS D'ARGENT | NO MONEY |
NOTOK | notOk_170 | VERLEGGING ANDER MOTOTEAM | DÉTOURNEMENT D'UNE AUTRE ÉQUIPE DE MOTOCYCLISTES | RELOCATION OF ANOTHER ENGINE TEAM |
NOTOK | notOk_180 | GOEDEREN NOG NIET BINNEN | MARCHANDISES NON ENCORE ENTRÉES | GOODS NOT YET IN |
NOTOK | notOk_190 | CONTAINER NOG NIET OP GIP | CONTENEUR PAS LE ENCORE SUR GIP | CONTAINER NOT YET ON GIP |
NOTOK | notOk_210 | DOC NOG BIJ VERIFICATEUR | LE DOCUMENT EST ENCORE CHEZ LE VÉRIFICATEUR | DOC STILL AT VERIFIER |
NOTOK | notOk_23 | GEWEIGERD DOOR ONTVANGER | REFUSÉ PAR LE DESTINATAIRE | REFUSED BY RECIPIENT |
NOTOK | notOk_230 | GESLOTEN WEGENS STAKING | FERMÉ POUR CAUSE DE GRÈVE | CLOSED DUE TO STRIKE |
NOTOK | notOk_24 | ADRES FOUT | ERREUR D'ADRESSE | ADDRESS ERROR |
NOTOK | notOk_24 | HUISNUMMER ONVOLLEDIG/ONTBREEKT | NUMÉRO DE MAISON INCOMPLET/ABSENT | HOUSE NUMBER INCOMPLETE/ABSENT |
NOTOK | notOk_290 | LAAD OF LOSREFERENTIE NODIG | CHARGEMENT OU DÉCHARGEMENT RÉFÉRENCE NÉCESSAIRE | LOADING OR UNLOADING REFERENCE NEEDED |
NOTOK | notOk_30 | CONTAINER NIET BINNEN | LE CONTENEUR N'EST PAS À L'INTÉRIEUR | CONTAINER NOT INSIDE |
NOTOK | notOk_31 | FIRMA BESTAAT NIET | L'ENTREPRISE N'EXISTE PAS | FIRM DOES NOT EXIST |
NOTOK | notOk_31 | PERSOON/FIRMA NIET GEKEND OP ADRES | PERSONNE/ENTREPRISE INCONNUE À L'ADRESSE | PERSON/FIRM NOT KNOWN AT ADDRESS |
NOTOK | notOk_310 | CONTAINER(S) REEDS GELADEN | CONTENEUR(S) DÉJÀ CHARGÉ(S) | CONTAINER(S) ALREADY LOADED |
NOTOK | notOk_34 | HERPLANNEN | REPROGRAMMATION | REPLAN |
NOTOK | notOk_350 | GOEDEREN MOGEN NIET WEG | LES MARCHANDISES NE PEUVENT PAS SORTIR | GOODS MAY NOT LEAVE |
NOTOK | notOk_350 | GOEDEREN MOGEN NOG NIET WEG | ||
NOTOK | notOk_360 | CONTAINER STAAT NIET VRIJ | LE CONTENEUR N'EST PAS GRATUIT | CONTAINER IS NOT FREE |
NOTOK | notOk_370 | 1 U. LUCHTEN, 3 U. DICHT | 1 H D'AÉRATION, 3 H DE FERMETURE | 1 H. AIRING, 3 H. CLOSE |
NOTOK | notOk_380 | 24 U. LUCHTEN | DIFFUSION EN 24h | 24 U. AIRING |
NOTOK | notOk_410 | OORSPRONGSVERKLARING VEREIST | DÉCLARATION D'ORIGINE REQUISE | ORIGIN DECLARATION REQUIRED |
NOTOK | notOk_420 | OPDRACHT NOG IN BEHANDELING | COMMANDE EN COURS | ORDER PENDING |
NOTOK | notOk_450 | ALLE AFSCHRIJFGEGEVENS NODIG | TOUTES LES DONNÉES DE DÉPRÉCIATION REQUISES | ALL DEPRECIATION DATA REQUIRED |
NOTOK | notOk_460 | KOPIE BL GEVRAAGD | COPIE BL DEMANDÉE | COPY BL REQUESTED |
NOTOK | notOk_470 | VERIFICATEUR AFWEZIG | VÉRIFICATEUR ABSENT | VERIFIER ABSENT |
NOTOK | notOk_480 | PERMIS NODIG | PERMIS NÉCESSAIRE | PERMIS NEEDED |
NOTOK | notOk_490 | BORG OK, NOG AF TE GEVEN AAN VERIFICATEUR | DÉPÔT OK, DOIT ENCORE ÊTRE DÉLIVRÉ AU VÉRIFICATEUR | DEPOSIT OK, YET TO BE ISSUED TO VERIFIER |
NOTOK | notOk_50 | MEER INFO VEREIST | PLUS D'INFORMATIONS NÉCESSAIRES | MORE INFO REQUIRED |
NOTOK | notOk_530 | KAAI GESLOTEN | QUAI FERMÉE | QUAY GESLOTEN |
NOTOK | notOk_540 | GASVRIJ VERKLARING NODIG | DÉCLARATION SUR L'ABSENCE DE GAZ NÉCESSAIRE | GAS-FREE DECLARATION NEEDED |
NOTOK | notOk_550 | WERKBON NODIG | ||
NOTOK | notOk_560 | OPDRACHT RETOUR | RETOUR D'ORDRE | ORDER RETURN |
NOTOK | notOk_580 | LEVERANCIERSVERKLARING NODIG | DÉCLARATION DU FOURNISSEUR NÉCESSAIRE | SUPPLIER'S DECLARATION NEEDED |
NOTOK | notOk_590 | PAKLIJST NODIG | LISTE DE COLISAGE NÉCESSAIRE | PACKING LIST NEEDED |
NOTOK | notOk_6 | EXTRA DOCUMENT NODIG | DOCUMENT SUPPLÉMENTAIRE NÉCESSAIRE | |
NOTOK | notOk_60 | FYSIEKE VERIFICATIE VEREIST | VÉRIFICATION PHYSIQUE REQUISE | PHYSICAL VERIFICATION REQUIRED |
NOTOK | notOk_600 | VERIF OK, AFSCHRIJVEN DOUANE | VÉRIFIER OK, DÉDUIRE LES FRAIS DE DOUANE | VERIF OK, WRITE OFF CUSTOMS |
NOTOK | notOk_70 | VERKEERDE KAAI | MAUVAIS QUAI | WRONG QUAY |
NOTOK | notOk_700 | GOED MAG WEG | BON PEUT S'EN ALLER | GOOD MAY GO |
NOTOK | notOk_710 | 1 U LUCHTEN | 1 H AIR | 1 H AIRING |
NOTOK | notOk_720 | LICENTIE NODIG | PERMIS NÉCESSAIRE | LICENCE NEEDED |
NOTOK | notOk_740 | OMGEZET NAAR DOC CONTROLE | CONVERTI EN DOC CONTROL | CONVERTED TO DOC CONTROL |
NOTOK | notOk_750 | LOSSEN MAGAZIJN | DÉCHARGEMENT DE L'ENTREPÔT | UNLOADING WAREHOUSE |
NOTOK | notOk_760 | VOLMACHT VEREIST | ||
NOTOK | notOk_770 | AANWEZIGHEID VAN GOEDEREN NODIG | ||
NOTOK | notOk_80 | GR2 NI 3X | GR2 NI 3X | GR2 NI 3X |
NOTOK | notOk_80 | LOSBON VEREIST | NOTE DE DÉCHARGE REQUISE | |
NOTOK | notOk_81 | GR2 NR3 | GR2 NR3 | GR2 NR3 |
NOTOK | notOk_82 | GR2 FUT DEL | GR2 FUT DEL | GR2 FUT DEL |
NOTOK | notOk_83 | GR2 NSP | GR2 NSP | GR2 NSP |
NOTOK | notOk_84 | GR2 NSS | ||
NOTOK | notOk_85 | GR2 NSN | GR2 NSN | GR2 NSN |
NOTOK | notOk_86 | GR2 MOVED | GR2 DÉPLACÉ | GR2 MOVED |
NOTOK | notOk_87 | GR2 REFUSED | GR2 REFUSÉ | GR2 REFUSED |
NOTOK | notOk_89 | GR2 INTERCEPT | GR2 INTERCEPT | GR2 INTERCEPT |
NOTOK | notOk_9 | LEGALISATIEKOST > 600EURO | COÛT DE LA LÉGALISATION > 600 EUROS | LEGALISATION FEE |
NOTOK | notOk_91 | GR2 INCOMPLETED SHIPMENT | GR2 TRANSFERT INCOMPLET | GR2 INCOMPLETED SHIPMENT |
NOTOK | notOk_92 | GR2 PICK-UP KIALAPUNT | GR2 PICK-UP KIALA POINT | GR2 PICK-UP KIALA POINT |
NOTOK | notOk_94 | GR2 UAP CLOSED | GR2 UAP FERMÉ | GR2 UAP CLOSED |
NOTOK | notOk_98 | ZENDING ONVOLLEDIG GELEVERD | LIVRAISON INCOMPLÈTE | SHIPMENT DELIVERED INCOMPLETE |
NOTOK | notOk_98 | ONVOLLEDIG GELEVERD | LIVRAISON INCOMPLÈTE | INCOMPLETELY DELIVERED |
NOTOK | notOk_98 | STRAAT ONBEKEND | RUE INCONNUE | STREET UNKNOWN |
NOTOK | notOk_990 | NIET KLAAR BIJ AFHALING | PAS PRÊT AU MOMENT DE L'ENLÈVEMENT | NOT READY ON COLLECTION |
PROCESSING | photo | Foto | Photo | Photo |
PROCESSING | phyEnd | Stop Fysieke Verificatie | Stop Verification Physique | Stop Physical Verification |
PROCESSING | phySample | Staalname | échantillonnage | Sample taking |
PROCESSING | phyStart | Start Fyieke Verificatie | Start Verification Physique | Start Physical Verification |
PROCESSING | pickup | Opgehaald | Enlevé | Picked up |
PROCESSING | PICKUP | Opgehaald | Pick-up | Pick-up |
PROCESSING | PICKUP_PLANNED | Ophaling gepland | Collecte planifiée | Pickup planned |
PROCESSING | PLANNED | Gepland | ||
PROCESSING | READY_TO_SEND | Trackingnummer | N° de tracking | Tracking number |
PROCESSING | READY_TO_SEND_add_track | Trackingnummer | N° de tracking | Tracking number |
NOTOK | REFUSED_BY_RECIPIENT | Geweigerd door bestemmeling | Refusé par le destinataire | Refused by recipient |
PROCESSING | take | Mee met koerier | En route avec courier | Taken by courier |
NOTOK | UNABLE_TO_DELIVER | Niet leverbaar | Impossible à livrer | Undeliverabla |
PROCESSING | ventClose | |||
PROCESSING | ventOpen | |||
DELIVERED | [distristatuscode]_201 | PERFECTE LEV./GEEN REMBOURS | ||
DELIVERED | [distristatuscode]_202 | PERFECTE LEV./CHEQUE | ||
DELIVERED | [distristatuscode]_203 | PERFECTE LEV./CASH GELD | ||
DELIVERED | [distristatuscode]_204 | PERFECTE LEV./OVERSCHRIJVING | ||
DELIVERED | [distristatuscode]_205 | AFGEZET BIJ DE BUREN | ||
DELIVERED | [distristatuscode]_206 | AFGEZET ZONDER HANDTEKENING | ||
PROCESSING | [distristatuscode]_207 | GEDEELTELIJKE LEVERING | ||
DELIVERED | [distristatuscode]_208 | PERFECTE LEV./RECAPZEGEL | ||
DELIVERED | [distristatuscode]_209 | GELEVERD VERPAKKING BESCHADIGD | ||
WARNING | [distristatuscode]_210 | NIET GELADEN, KON ER NIET IN | ||
WARNING | [distristatuscode]_211 | GESLOTEN,TE VROEG(FOUT ONTIME) | ||
WARNING | [distristatuscode]_212 | GESLOTEN,TE LAAT (FOUT ONTIME) | ||
WARNING | [distristatuscode]_213 | GESLOTEN MIDDAG (FOUT ONTIME) | ||
WARNING | [distristatuscode]_214 | NIET GELADEN, VERGETEN | ||
WARNING | [distristatuscode]_215 | NIET GELEVERD AKKOORD DISPATCH | ||
NOTOK | [distristatuscode]_216 | REEDS GELEVERD (FOUT ONTIME) | ||
WARNING | [distristatuscode]_217 | NIET GELADEN,AFW. IN MAGAZIJN | ||
WARNING | [distristatuscode]_218 | NIET GELEVERD DOOR PANNE | ||
WARNING | [distristatuscode]_219 | ADRES NIET GEVONDEN | ||
WARNING | [distristatuscode]_220 | VERKEERD ADRES | ||
WARNING | [distristatuscode]_221 | GESLOTEN (REDEN ONBEKEND) | ||
WARNING | [distristatuscode]_222 | SLUITINGSDAG | ||
WARNING | [distristatuscode]_223 | NIET BEREIKBAAR,MORGEN WEL | ||
WARNING | [distristatuscode]_225 | JAARLIJKS VERLOF | ||
WARNING | [distristatuscode]_226 | GESLOTEN,TE VROEG (FOUT KLANT) | ||
WARNING | [distristatuscode]_227 | GESLOTEN,TE LAAT (FOUT KLANT) | ||
WARNING | [distristatuscode]_228 | GESLOTEN MIDDAG (FOUT KLANT) | ||
NOTOK | [distristatuscode]_230 | WEIGERING (KAN NIET BETALEN) | ||
NOTOK | [distristatuscode]_231 | WEIGERING (VERKEERDE GOEDEREN) | ||
NOTOK | [distristatuscode]_232 | WEIGERING (VERKEERDE REMBOURS) | ||
NOTOK | [distristatuscode]_233 | WEIGERING (NIET BESTELD) | ||
NOTOK | [distristatuscode]_234 | WEIGERING (TE LATE LEVERING) | ||
NOTOK | [distristatuscode]_235 | WEIGERING (WIL GEEN REMBOURS) | ||
NOTOK | [distristatuscode]_236 | WEIGERING (SCHADE GOEDEREN) | ||
PROCESSING | [distristatuscode]_249 | GEDEELTELIJKE AFHALING | ||
PROCESSING | [distristatuscode]_250 | AFHALING OK | ||
WARNING | [distristatuscode]_251 | AFHALING GOEDEREN NIET KLAAR | ||
WARNING | [distristatuscode]_252 | AFHALING REEDS UITGEVOERD | ||
WARNING | [distristatuscode]_253 | AFHALING MEN WEET VAN NIETS | ||
WARNING | [distristatuscode]_254 | AFHALING TE VROEG (FOUT KLANT) | ||
WARNING | [distristatuscode]_255 | AFHALING TE LAAT (FOUT KLANT) | ||
WARNING | [distristatuscode]_256 | AFHALING MIDDAG (FOUT KLANT) | ||
WARNING | [distristatuscode]_257 | AFHALING TE VROEG (FOUT ONTIME | ||
WARNING | [distristatuscode]_258 | AFHALING TE LAAT (FOUT ONTIME) | ||
WARNING | [distristatuscode]_259 | AFHALING MIDDAG (FOUT ONTIME) |