API PostNL Extensie. Documentinformatie en copyright Document: tig_postnl_extensie_api_handleiding.docx Laatst gewijzigd op: :20 PM

Transcriptie

1 API PostNL Extensie Documentinformatie en copyright Document: tig_postnl_extensie_api_handleiding.docx Laatst gewijzigd op: :20 PM Copyright 2015 Total Internet Group B.V. - Niets uit deze uitgave mag vermenigvuldigd of openbaar gemaakt worden zonder toestemming van de Total Internet Group.

2 Inleiding Deze handleiding is bedoeld voor ontwikkelaars die contact willen leggen en data uit willen wisselen met de PostNL extensie van een Magento installatie waar een installatie van de PostNL extensie actief is. Contactgegevens TIG, voor technische vragen Telefoon: Deze handleiding beschrijft functionaliteiten van de PostNL extensie en hoe deze vanaf een extern system aangeroepen kunnen worden. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 2

3 1 Algemene informatie De PostNL Extensie API wordt aangeboden in de vorm van additionele functies op de standaard Magento SOAP v2 API. Informatie over de algemene Magento SOAP v2 API kunt u hier vinden: Om gebruik te maken van de PostNL API moet een API gebruiker worden aangemaakt in Magento met de juiste rechten. Voor meer informatie over het aanmaken van API gebruikers kunt u dit artikel lezen: TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 3

4 2 Functies De volgende functies zijn beschikbaar. Heeft u behoefte aan additionele functionaliteiten via de PostNL API? Neem dan s.v.p. contact op met de TIG servicedesk. N.B. Optionele waardes zijn schuingedrukt. 2.1 login (username, orderids) Deze functie wordt gebruikt om een nieuwe API sessie aan te maken. Deze sessie is nodig voor alle verdere API functies. username string Magento API username apikey string Magento API apikey sessionid stringg Magento API sessie-id. Benodigd voor verdere communicatie met de API. 2.2 postnlgettrackandtraceurls (sessionid, orderids) Met deze functie kunt u informatie over de Track & Trace pagina krijgen van de opgegeven zendingen. shipmentids string[] Lijst van zending ID s waarvoor de informatie opgehaald moet worden. return postnltrackandtraceurlentity[] Lijst van PostNL Track & Trace informatie. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 4

5 2.3 postnlgetstatusinfo (sessionid, orderids) Met deze functie kunt u informatie over de verzendstatus van de opgegeven zendingen krijgen. shipmentids string[] Lijst van zending ID s waarvoor de informatie opgehaald moet worden. return postnlshippingstatusentity[] Lijst van PostNL verzendstatus informatie. 2.4 postnlcreateshipments Met deze functie kunt u zendingen aanmaken voor de opgegeven bestellingen. N.B. de geconfigureerde PostNL verzendopties zullen gebruikt worden voor het aanmaken van de zendingen. orderids string[] Lijst van order ID s waarvoor de zendingen aangemaakt moeten worden. return postnlshipment[] Lijst van PostNL zendingen die aangemaakt zijn. 2.5 postnlconfirmshipments Met deze functie kunt u de opgegeven PostNL zendingen voormelden bij PostNL. shipmentids string[] Lijst van zending ID s die voorgemeld moeten worden. return postnlshipment[] Lijst van PostNL zendingen die voorgemeld zijn. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 5

6 2.6 postnlprintshippinglabels Met deze functie kunt u PostNL verzendlabels aanvragen voor de opgegeven zendingen. shipmentids string[] Lijst van zending ID s die waarvoor de verzendlabels opgevraagd moeten worden. labelsize string Het gewenste label formaat. Moet A4 of A6 bevatten. labelstartposition integer De positie op een A4 vel waar de labels moeten beginnen met printen. Deze parameter wordt genegeerd indien A6 is opegegeven voor de labelsize parameter. Moet een getal van 1 t/m 4 bevatten. return postnlprintedlabelentity[] Lijst van PostNL verzendlabels. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 6

7 2.7 postnlconfirmandprintshippinglabels Met deze functie kunt u PostNL verzendlabels aanvragen voor de opgegeven zendingen en deze zendingen direct voormelden. shipmentids string[] Lijst van zending ID s die waarvoor de verzendlabels opgevraagd moeten worden. labelsize string Het gewenste label formaat. Moet A4 of A6 bevatten. labelstartposition integer De positie op een A4 vel waar de labels moeten beginnen met printen. Deze parameter wordt genegeerd indien A6 is opegegeven voor de labelsize parameter. Moet een getal van 1 t/m 4 bevatten. return postnlprintedlabelentity[] Lijst van PostNL verzendlabels. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 7

8 2.8 postnlcreateshipmentsconfirmandprintlabels Met deze functie kunt u zendingen aanmaken voor de opgegeven order ID s. Deze zendingen worden vervolgens direct voorgemeld en de verzendlabels worden direct opgevraagd. orderids string[] Lijst van order ID s die waarvoor de handelingen uitgevoerd moeten worden. labelsize string Het gewenste label formaat. Moet A4 of A6 bevatten. labelstartposition integer De positie op een A4 vel waar de labels moeten beginnen met printen. Deze parameter wordt genegeerd indien A6 is opegegeven voor de labelsize parameter. Moet een getal van 1 t/m 4 bevatten. return postnlprintedlabelentity[] Lijst van PostNL verzendlabels. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 8

9 3 Beschrijving van variabelen N.B. waardes die optioneel zijn, zijn schuingedrukt. postnlerror inhoud entity_id string ID van de entity waar deze foutmelding betrekking op heeft. code string Foutcode van deze foutmelding. description string Beschrijving van deze foutmelding. postnlwarning inhoud entity_id string ID van de entity waar deze waarschuwing betrekking op heeft. code string Foutcode van deze waarschuwing. description string Beschrijving van deze waarschuwing. postnlshipmententity inhoud order_id string Order ID van deze zending. shipment_id string Zending ID van deze zending. warning postnlwarning[] Lijst van waarschuwingen. error postnlerror[] Lijst van foutmeldingen. postnlprintedlabelentity inhoud order_id string Order ID van deze zending. shipment_id string Zending ID van deze zending. label string Een base64-encoded PDF label. warning postnlwarning[] Lijst van waarschuwingen. error postnlerror[] Lijst van foutmeldingen. postnlbarcodesarray inhoud shipment string[] Een lijst van barcodes voor deze zending. return string[] Een lijst van barcodes voor de retourzending behorende bij deze zending. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 9

10 postnltrackandtraceurlentity inhoud order_id string Order ID van de zending. shipment_id string Zending ID van de zending. track_and_trace_url string URL van de Track & Trace pagina van de zending. main_barcode string Primaire barcode van de zending. return_barcode string Primaire barcode van de retourzending van deze zending. all_barcodes postnlbarcodesarray Lijst van alle barcodes die bij deze zending horen. warning postnlwarning[] Lijst van waarschuwingen. error postnlerror[] Lijst van foutmeldingen. postnlshippingstatusentity inhoud order_id string Order ID van de zending. shipment_id string Zending ID van de zending. shipping_phase string Huidige verzendfase van deze zending. return_phase string Verzendfase van de retourzending behorende bij deze zending. warning postnlwarning[] Lijst van waarschuwingen. error postnlerror[] Lijst van foutmeldingen. TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 10

11 4 Voorbeeldcode Zie: TIG Kabelweg 37, 1014 BA, Amsterdam, NL tig.nl tig_postnl_extensie_api_handleiding.docx 11