Dit artikel bevat de technische specificaties van de addExistingShipment-call van de Paazl SOAP API.
Gebruik dit verzoek om een verzendopdracht naar Paazl te sturen, zodat Paazl deze kan monitoren en jouw webshop kan bijwerken met de bijbehorende leveringsstatus. Het verzoek bevat een lijst met alle zendingen, samen met hun tracking-, verzend- (dispatch) en referentienummers. Het bevat ook lijsten van de pakketten van elke zending en hun bijbehorende barcodes.
Houd er rekening mee dat een enkele zending gecorreleerd is aan een enkele referentie in jouw webshop. Je kunt meerdere pakketten aan de zending toevoegen.
Opmerking
- Voordat je een
addExistingShipment-verzoek verzendt, moet je er eerst voor zorgen dat de betreffende bestelling definitief is gemaakt (committed) in de Paazl-database. Dit kun je doen met hetcommitOrder-verzoek, of je kunt de bestelling handmatig aanmaken in jouw Paazl-webapp-account. - Om prestatieredenen is het aantal zendingen dat je in één verzoek kunt opnemen beperkt tot 20.
- Om prestatieredenen is het aantal pakketten dat je in een zending kunt opnemen beperkt tot 15.
- Het trackingnummer en verzendnummer (dispatch number) van een zending zijn in principe optioneel, maar ze kunnen vereist zijn door een specifieke vervoerder.
Request
Elementspecificaties
| Element | Type | Verplicht? | Beschrijving |
|---|---|---|---|
hash | String(255) | Ja | Een met SHA-1 versleutelde authenticatiecode. De string die je versleutelt is een samenvoeging van de volgende substrings: <webshop-id> + <integratiewachtwoord> + <huidige datum: YYYYMMDD> Je vindt het webshop-id en het integratiewachtwoord in de Paazl-interface onder Instellingen > Mijn account. Voorbeeld Webshop-id: "123" Integratiewachtwoord: "mijnWachtwoord" Datum: "18 april 2018" Te versleutelen string: "123mijnWachtwoord20180418" |
webshop | long(10) | Ja | Het webshop-id van jouw hoofdwebshop. Je vindt dit in de Paazl-interface onder Instellingen > Mijn account. |
targetWebshop | long(10) | Nee | Gebruik je meerdere webshops? Dan is dit het webshop-id van een onderliggende webshop (ook wel bekend als Paazl-subaccount). Je vindt dit in het account van de betreffende onderliggende webshop onder Instellingen > Mijn account. De |
reference | String(255) | Ja | De referentiecode van jouw webshop voor de betreffende verzendopdracht. |
trackingNumber | String(255) | Voorwaardelijk | Het Paazl-specifieke trackingnummer van een verzendopdracht. Dit is in principe optioneel, maar kan vereist zijn door een vervoerder. Opmerking: Het Paazl-trackingnummer kan afwijken van het trackingnummer van de vervoerder. |
dispatchNumber | String(255) | Voorwaardelijk | Het Paazl-specifieke verzendnummer (dispatch number) van een verzendopdracht. Dit is in principe optioneel, maar kan vereist zijn door een vervoerder. Opmerking: Het Paazl-verzendnummer kan afwijken van het verzendnummer van de vervoerder. |
barcode | String(255) | Ja | De barcode die een vervoerder toekent aan een verzendopdracht. Opmerking: Paazl valideert de inhoud van dit element niet. |
trackingUrl | anyURI | Nee | De tracking-URL die door de vervoerder is verstrekt. |
Voorbeeld request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mat="http://www.paazl.com/schemas/matrix"> <soapenv:Header/> <soapenv:Body> <mat:addExistingShipmentRequest> <mat:hash>d1ff54233c8efe214ed14fef06facbf76283410d</mat:hash> <mat:webshop>804</mat:webshop> <mat:targetWebshop></mat:targetWebshop> <mat:shipments> <mat:shipment> <mat:reference>Order001</mat:reference> <mat:trackingNumber></mat:trackingNumber> <mat:dispatchNumber></mat:dispatchNumber> <mat:parcels> <mat:parcel> <mat:barcode>Parcel001</mat:barcode> <mat:trackingUrl>track@myshop.com</mat:trackingUrl> </mat:parcel> </mat:parcels> </mat:shipment> </mat:shipments> </mat:addExistingShipmentRequest> </soapenv:Body> </soapenv:Envelope>
Response
Elementspecificaties
| Element | Type | Beschrijving |
|---|---|---|
code | String(10) | De unieke code van het resultaat van de API-call. |
message | String(255) | Een beschrijving van het resultaat. Als het resultaat een foutmelding (error) is, raadpleeg dan SOAP API-status- en foutcodes voor een uitleg van de foutmelding en de acties die je kunt ondernemen. |
Voorbeeld response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <addExistingShipmentResponse xmlns="http://www.paazl.com/schemas/matrix"> <message>Success</message> </addExistingShipmentResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Was dit artikel nuttig?
Dat is fantastisch!
Hartelijk dank voor uw beoordeling
Sorry dat we u niet konden helpen
Hartelijk dank voor uw beoordeling
Feedback verzonden
We stellen uw moeite op prijs en zullen proberen het artikel te verbeteren