apaczka Webservice API Właściciel dokumentu: R2G Wersja dokumentu: 1.5 Status dokumentu: Draft Data utworzenia: 13.09.2012 Data zapisu: 15.09.2012 Autorzy: Piotr Jatymowicz, Piotr Dobrzyński R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 1/32
Spis treści 1. Wprowadzenie... 3 1.1. Cel... 3 1.2. Wymagania... 3 1.3. Technologie... 3 1.4. Plan integracji... 3 1.5. Załączniki... 4 2. OrderService... 4 2.1. placeorder... 4 2.1.1. Komunikaty wysyłane... 4 2.1.2. Komunikaty odbierane... 9 2.1.3. Przykład... 14 2.1.4. Kody błędów... 17 2.2. getwaybilldocument... 18 2.2.1. Komunikaty wysyłane... 18 2.2.2. Komunikaty odbierane... 19 2.2.3. Przykład... 19 2.3. getcollectivewaybilldocument... 20 2.3.1. Komunikaty wysyłane... 20 2.3.2. Komunikaty odbierane... 20 2.3.3. Przykład... 21 2.4. getcollectiveturnincopydocument... 22 2.4.1. Komunikaty wysyłane... 22 2.4.2. Komunikaty odbierane... 22 2.4.3. Przykład... 23 2.5. getcountries... 24 2.5.1. Komunikaty wysyłane... 24 2.5.2. Komunikaty odbierane... 24 2.5.3. Przykład... 25 2.6. validateauthdata... 26 2.6.1. Komunikaty wysyłane... 26 2.6.2. Komunikaty odbierane... 26 2.6.3. Przykład... 27 2.6.4. Kody błędów... 27 2.7. registercustomer...28 2.7.1. Komunikaty wysyłane... 28 2.7.2. Komunikaty odbierane... 30 2.7.3. Przykład... 30 2.76.4. Kody błędów... 31 R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 2/32
1. Wprowadzenie 1.1. Cel apaczka Webservice API jest interfejsem programistycznym do aplikacji apaczka.pl. Serwis umożliwia integrację zewnętrzych systemów w celu wysyłania paczek za pośrednictwem apaczki, bez konieczności używania interfejsu użytkownika. 1.2. Wymagania Do korzystania z apaczka Webservice API klient musi mieć podpisaną umowę z Apaczką oraz otrzymać webservice api key. 1.3. Technologie Apaczka Webservice API wykorzystuje standardowe technologie komunikacyjne: o HTTP o SSL o SOAP o WSDL 1.4. Plan integracji W celu pomyślnej integracji i wyeliminowania błędów udostępniony zostanie system testowy. Dopiero po udanej integracji z systemem testowym, klient będzie mógł korzystać z systemu produkcyjnego. Plan integracji z systemem testowym: 1. Klient zgłasza chęć integracji z systemem Apaczka. Podaje numer IP komputera, z którego będzie się łączyć z systemem testowym. R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 3/32
2. Po uzyskaniu dostępu z systemem testowym, klient zakłada konto testowe za pomocą interfejsu użytkownika. Proces rejestracji klienta w systemie testowym odbywa się analogicznie do systemu produkcyjnego. 3. Klient tworzy użytkownika w systemie testowym, który będzie używany do wołania webservice ów Apaczki. 4. Klient zgłasza do Apaczki login użytkownika, który będzie wykorzystywany do wołania webservice ów. W odpowiedzi dostaje klucz web service api. Wszelkie zmiany w specyfikacji webservice ów będą wdrażane w pierwszej kolejności do systemu testowego. Po pomyślnej integracji z serwisem testowym, klient powinien wystąpić o klucz do serwisu produkcyjnego, podając login użytkownika, który będzie używany do komunikacji z webservicem. 1.5. Załączniki Do dokumentu powinny być załączone: o Plik WSDL ze specyfikacją webservice u. 2. OrderService OrderService jest webservicem używanym do składania zamówień i pobieraniu informacji o zamówieniu. 2.1. placeorder Operacja placeorder służy do składania zamówień na wysłanie paczki. 2.1.1. Komunikaty wysyłane Ścieżka Typ Wymagane Opis PlaceOrderRequest T Żądanie złożenia zamówienia R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 4/32
Ścieżka Typ Wymagane Opis PlaceOrderRequest/authoriz ation PlaceOrderRequest/authoriz ation/ apikey PlaceOrderRequest/authoriz ation/ login PlaceOrderRequest/authoriz ation/ password accountnumber codamount contents isdomestic notificationdelivered notificationdelivered/ isreceiveremail notificationdelivered/ isreceiversms notificationdelivered/ issenderemail notificationdelivered/ issendersms notificationexception notificationexception/ isreceiveremail notificationexception/ isreceiversms notificationexception/ issenderemail T Autoryzacja użytkownika T Klucz użytkownika do Apaczka Webservice API T Login użytkownika T Hasło użytkownika N* Nr konta dla przesyłek pobraniowych. Wymagane, gdy podano opcję POBRANIE. Long N* Kwota pobrania (w groszach). Wymagane, gdy podano opcję POBRANIE. (35) T Zawartość przesyłki T Czy przesyłka krajowa (true, false) T Powiadomienia o dostarczeniu przesyłki T Czy wysyłać email do adresata przesyłki po zmianie statusu na dostarczoną. T Czy wysyłać sms do adresata przesyłki po zmianie statusu na dostarczoną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na dostarczoną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na dostarczoną. T Powiadomienia o wyjątku T Czy wysyłać email do adresata przesyłki po zmianie statusu na wyjątek. T Czy wysyłać sms do adresata przesyłki po zmianie statusu na wyjątek. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wyjątek. R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 5/32
Ścieżka Typ Wymagane Opis notificationexception/ issendersms notificationnew notificationnew/isreceiver Email notificationnew/isreceiver Sms notificationnew/issenderem ail notificationnew/issendersm s notificationsent notificationsent/ isreceiveremail notificationsent/isreceive rsms notificationsent/issendere mail notificationsent/issenders ms options T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wyjątek. T Powiadomienia o utworzeniu przesyłki T Czy wysyłać email do adresata przesyłki po zmianie statusu na utworzoną. T Czy wysyłać sms do adresata przesyłki po zmianie statusu na utworzoną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na utworzoną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na utworzoną. T Powiadomienia o wysłaniu przesyłki T Czy wysyłać email do adresata przesyłki po zmianie statusu na wysłaną. T Czy wysyłać sms do adresata przesyłki po zmianie statusu na wysłaną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wysłaną. T Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wysłaną. List<> N Opcje zamówienia. Dopuszczalne wartości: Dla UPS: POBRANIE, ZWROT_DOK - zwrot dokumentów, DOR_OSOBA_PRYW - doręczenie osoba prywatna, DOST_SOB - dostawa w sobotę, PODPIS_DOROS - podpis osoby dorosłej Dla DHL: POBRANIE, DOST_SOB - dostawa w sobotę, ZWROT_DOK - zwrot dokumentów orderpickuptype OrderPickupType T Typ odbioru przesyłki. Dopuszczalne wartości: COURIER zamówienie odbioru przesyłek, SELF dostarczenie samodzielnie do R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 6/32
Ścieżka Typ Wymagane Opis UPS, EVERYDAY umówiony codzienny odbiór z kurierem, PHONE zamówienie kuriera samodzielnie przez telefon pickupdate pickuptimefrom pickuptimeto receiver receiver/addressline1 receiver/addressline2 receiver/city receiver/contactname receiver/countryid receiver/email receiver/name receiver/phone receiver/postalcode receiver/statecode referencenumber Date N* Data odbioru przesyłki przez kuriera. Wymagane dla orderpickuptype = COURIER. Hour N* Godzina odbioru od. Wymagane dla orderpickuptype = COURIER. Hour N* Godzina odbioru do (musi być dokładnie większa o 3 od godziny odbioru od w UPS i o 2 godziny w DHL). Wymagane dla orderpickuptype = COURIER. T Dane adresata. (35) T Pierwsza linia adresu. (35) N Druga linia adresu. (35) T Miasto. (35) T Imię i nazwisko osoby kontaktowej. Long T Identyfikator kraju (patrz getcountries). (100) N Adres email. (35) T Nazwa odbiorcy (nazwa firmy). (15) T Numer telefonu osoby kontaktowej. (10) T Kod pocztowy. N Kod stanu. Wymagany dla niektórych krajów. (35) N Dodatkowy opis (np. nr zamówienia, faktury). R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 7/32
Ścieżka Typ Wymagane Opis sender sender/addressline1 sender/addressline2 sender/city sender/contactname sender/countryid sender/email sender/name sender/phone sender/postalcode sender/statecode servicecode T Dane nadawcy. (35) T Pierwsza linia adresu. (35) N Druga linia adresu. (35) T Miasto. (35) T Imię i nazwisko osoby kontaktowej. Long T Identyfikator kraju (patrz getcountries). (100) N Adres email. (35) T Nazwa nadawcy (nazwa firmy). (15) N Numer telefonu osoby kontaktowej. (10) T Kod pocztowy. N Kod stanu. Wymagany dla niektórych krajów. T Kod usługi. Dopuszczalne wartości: Usługi krajowe: UPS_K_STANDARD - UPS Standard UPS_K_EX_SAV - UPS Express Saver UPS_K_EX - UPS Express UPS_K_EXP_PLUS - UPS Express Plus DHLSTD - DHL Standard DHL12 - DHL Express 12 DHL09 - DHL Express 9 DHL1722 - DHL 17-22 shipments shipments/shipment List<Shipment> T Lista paczek do wysłania. T Dane paczki. R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 8/32
Ścieżka Typ Wymagane Opis shipments/shipment/dimensi on1 shipments/shipment/dimensi on2 shipments/shipment/dimensi on3 shipments/shipment/options shipments/shipment/positio n shipments/shipment/ shipmenttypecode shipments/shipment/ shipmentvalue shipments/shipment/weight Long T Długość cm. Long T Szerokość cm. Long T Wysokość cm. List<> N Opcje paczki. Dopuszczalne wartości: UBEZP dodatkowe ubezpieczenie paczki, PRZES_NIETYP przesyłka nietypowa (wymaga dodatkowej obsługi) DUZA_PACZKA duża paczka (tylko dla UPS) Long T Nr porządkowy paczki (liczony od 0). T Typ przesyłki. Dopuszczalne wartości: LIST, PACZ - paczka Long N* Wartość przysyłki w groszach (do ubezpieczenia). Wymagane, gdy podano opcję UBEZP. BigDecimal T Waga przesyłki (w kg). 2.1.2. Komunikaty odbierane Odpowiedź serwera zawiera potencjalnie listę błędów oraz obiekt zamówienia uzupełniony o: o Id zamówienia, o Wartość netto zamówienia, o Numer listu przewozowego, o Opcje zamówienia i przesyłek mogą być uzupełnione o dodatkowe wymagane opcje. Ścieżka Typ Opis PlaceOrderResponse Odpowiedź złożenia zamówienia R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 9/32
Ścieżka Typ Opis PlaceOrderResponse/result Rezultat operacji PlaceOrderResponse/result/ messages PlaceOrderResponse/result/ messages/message PlaceOrderResponse/result/ messages/message/code PlaceOrderResponse/result/ messages/message/description PlaceOrderResponse/result/ messages/message/severity accountnumber codamount contents List<Message> Long (35) Lista komunikatów Komunikat Kod komunikatu Opis komunikatu ERROR, INFO, WARN. W przypadku ERROR, zamówienie nie zostało złożone. Nr konta dla przesyłek pobraniowych Kwota pobrania (w groszach) Zawartość przesyłki id Long Id zamówienia isdomestic netamount notificationdelivered notificationdelivered/ isreceiveremail Long Czy przesyłka krajowa (true, false) Kwota netto (w groszach) Powiadomienia o dostarczeniu przesyłki Czy wysyłać email do adresata przesyłki po zmianie statusu na dostarczoną. notificationdelivered/ isreceiversms Czy wysyłać sms do adresata przesyłki po zmianie statusu na dostarczoną. notificationdelivered/ issenderemail Czy wysyłać email do nadawcy przesyłki po zmianie statusu na dostarczoną. notificationdelivered/ issendersms Czy wysyłać email do nadawcy przesyłki po zmianie statusu na dostarczoną. notificationexception Powiadomienia o wyjątku R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 10/32
Ścieżka Typ Opis notificationexception/ isreceiveremail Czy wysyłać email do adresata przesyłki po zmianie statusu na wyjątek. notificationexception/ isreceiversms Czy wysyłać sms do adresata przesyłki po zmianie statusu na wyjątek. notificationexception/ issenderemail Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wyjątek. notificationexception/ issendersms Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wyjątek. notificationnew Powiadomienia o utworzeniu przesyłki notificationnew/isreceiveremail Czy wysyłać email do adresata przesyłki po zmianie statusu na utworzoną. notificationnew/isreceiversms notificationnew/issenderemail notificationnew/issendersms notificationsent notificationsent/ isreceiveremail Czy wysyłać sms do adresata przesyłki po zmianie statusu na utworzoną. Czy wysyłać email do nadawcy przesyłki po zmianie statusu na utworzoną. Czy wysyłać email do nadawcy przesyłki po zmianie statusu na utworzoną. Powiadomienia o wysłaniu przesyłki Czy wysyłać email do adresata przesyłki po zmianie statusu na wysłaną. notificationsent/isreceiversms notificationsent/issenderemail notificationsent/issendersms options List<> Czy wysyłać sms do adresata przesyłki po zmianie statusu na wysłaną. Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wysłaną. Czy wysyłać email do nadawcy przesyłki po zmianie statusu na wysłaną. Opcje zamówienia. Dopuszczalne wartości: POBRANIE, ZWROT_DOK - zwrot dokumentów, DOR_OSOBA_PRYW - doręczenie osoba prywatna, DOST_SOB - dostawa w sobotę, R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 11/32
Ścieżka Typ Opis PODPIS_DOROS - podpis osoby dorosłej orderpickuptype OrderPickupType Typ odbioru przesyłki. Dopuszczalne wartości: COURIER zamówienie odbioru przesyłek, SELF dostarczenie samodzielnie do UPS, EVERYDAY umówiony codzienny odbiór z kurierem, PHONE zamówienie kuriera samodzielnie przez telefon pickupdate pickuptimefrom pickuptimeto receiver receiver/addressline1 receiver/addressline2 receiver/city receiver/contactname receiver/countryid receiver/email receiver/name receiver/phone receiver/postalcode receiver/statecode Date Hour Hour (35) (35) (35) (35) Long (100) (35) (15) (10) Data odbioru przesyłki przez kuriera. Wymagane dla orderpickuptype = COURIER. Godzina odbioru od. Wymagane dla orderpickuptype = COURIER. Godzina odbioru do (musi być dokładnie większa o 3 od godziny odbioru od). Wymagane dla orderpickuptype = COURIER. Dane adresata. Pierwsza linia adresu. Druga linia adresu. Miasto. Imię i nazwisko osoby kontaktowej. Identyfikator kraju (patrz getcountries). Adres email. Nazwa odbiorcy (nazwa firmy). Numer telefonu osoby kontaktowej. Kod pocztowy. Kod stanu. Wymagany dla niektórych krajów. R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 12/32
Ścieżka Typ Opis referencenumber sender sender/addressline1 sender/addressline2 sender/city sender/contactname sender/countryid sender/email sender/name sender/phone sender/postalcode sender/statecode servicecode (35) (35) (35) (35) (35) Long (100) (35) (15) (10) Dodatkowy opis (np. nr zamówienia, faktury). Dane nadawcy. Pierwsza linia adresu. Druga linia adresu. Miasto. Imię i nazwisko osoby kontaktowej. Identyfikator kraju (patrz getcountries). Adres email. Nazwa nadawcy (nazwa firmy). Numer telefonu osoby kontaktowej. Kod pocztowy. Kod stanu. Wymagany dla niektórych krajów. Kod usługi. Dopuszczalne wartości: Usługi krajowe: UPS_K_STANDARD - UPS Standard UPS_K_EX_SAV - UPS Express Saver UPS_K_EX - UPS Express UPS_K_EXP_PLUS - UPS Express Plus DHLSTD - DHL Standard DHL12 - DHL Express 12 DHL09 - DHL Express 9 DHL1722 - DHL 17-22 Usługi zagraniczne: UPS_Z_STANDARD - UPS Standard UPS_Z_EX_SAV - UPS Express Saver UPS_Z_EX - UPS Express UPS_Z_EXPEDITED - UPS Expedited R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 13/32
shipments shipments/shipment shipments/shipment/dimension1 shipments/shipment/dimension2 shipments/shipment/dimension3 List<Shipment> Long Long Long Lista paczek do wysłania. Dane paczki. Długość cm. Szerokość cm. Wysokość cm. shipments/shipment/options shipments/shipment/position List<> Opcje paczki. Dopuszczalne wartości: UBEZP dodatkowe ubezpieczenie paczki, PRZES_NIETYP przesyłka nietypowa (wymaga dodatkowej obsługi) DUZA_PACZKA duża paczka Long Nr porządkowy paczki (liczony od 0). shipments/shipment/ shipmenttypecode shipments/shipment/ shipmentvalue Long Typ przesyłki. Dopuszczalne wartości: LIST, PACZ - paczka Wartość przysyłki w groszach (do ubezpieczenia). shipments/shipment/weight waybillnumber BigDecimal Waga przesyłki (w kg). Numer listu przewozowego 2.1.3. Przykład Żądanie: <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.pretius.com"> <soapenv:header/> <soapenv:body> <api:placeorder> <api:placeorderrequest> <api:authorization> <api:apikey>apikeytest</api:apikey> <api:login>apitest</api:login> <api:password>apitest</api:password> </api:authorization> <api:order> <api:contents>zawartosc</api:contents> <api:isdomestic>true</api:isdomestic> <api:notificationdelivered> <api:isreceiveremail>true</api:isreceiveremail> <api:isreceiversms>false</api:isreceiversms> R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 14/32
<api:issenderemail>true</api:issenderemail> <api:issendersms>false</api:issendersms> </api:notificationdelivered> <api:notificationexception> <api:isreceiveremail>false</api:isreceiveremail> <api:isreceiversms>false</api:isreceiversms> <api:issenderemail>false</api:issenderemail> <api:issendersms>false</api:issendersms> </api:notificationexception> <api:notificationnew> <api:isreceiveremail>false</api:isreceiveremail> <api:isreceiversms>false</api:isreceiversms> <api:issenderemail>false</api:issenderemail> <api:issendersms>false</api:issendersms> </api:notificationnew> <api:notificationsent> <api:isreceiveremail>false</api:isreceiveremail> <api:isreceiversms>false</api:isreceiversms> <api:issenderemail>false</api:issenderemail> <api:issendersms>false</api:issendersms> </api:notificationsent> <api:options> <api:string>dor_osoba_pryw</api:string> </api:options> <api:orderpickuptype>courier</api:orderpickuptype> <api:pickupdate>2010-04-12</api:pickupdate> <api:pickuptimefrom>12:00</api:pickuptimefrom> <api:pickuptimeto>15:00</api:pickuptimeto> <api:receiver> <api:addressline1>ul. Blabla 6</api:addressLine1> <api:addressline2></api:addressline2> <api:city>warszawa</api:city> <api:contactname>blabla</api:contactname> <api:countryid>0</api:countryid> <api:email>test@test.com</api:email> <api:name>b</api:name> <api:phone>123456789</api:phone> <api:postalcode>01-990</api:postalcode> </api:receiver> <api:referencenumber>numer</api:referencenumber> <api:sender> <api:addressline1>ul. rtrttrt 6</api:addressLine1> <api:addressline2></api:addressline2> <api:city>warszawa</api:city> <api:contactname>ppp</api:contactname> <api:countryid>0</api:countryid> <api:email>test@test.com</api:email> <api:name>p</api:name> <api:phone>123456789</api:phone> <api:postalcode>02-222</api:postalcode> </api:sender> <api:servicecode>ups_k_standard</api:servicecode> <api:shipments> <api:shipment> <api:options> </api:options> <api:position>1</api:position> <api:shipmenttypecode>pacz</api:shipmenttypecode> <api:shipmentvalue>100</api:shipmentvalue> <api:weight>3</api:weight> <api:dimension1>4</api:dimension1> <api:dimension2>3</api:dimension2> <api:dimension3>5</api:dimension3> </api:shipment> </api:shipments> </api:order> </api:placeorderrequest> </api:placeorder> </soapenv:body> </soapenv:envelope> Odpowiedź: <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body> <ns1:placeorderresponse xmlns:ns1="http://api.pretius.com"> R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 15/32
<ns1:return> <ns1:order> <ns1:accountnumber ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschemainstance"/> <ns1:codamount ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschema- instance"/> instance"/> instance"/> instance"/> <ns1:contents>zawartosc</ns1:contents> <ns1:id>189050</ns1:id> <ns1:isdomestic>true</ns1:isdomestic> <ns1:netamount>931</ns1:netamount> <ns1:notificationdelivered> <ns1:isreceiveremail>true</ns1:isreceiveremail> <ns1:isreceiversms>false</ns1:isreceiversms> <ns1:issenderemail>true</ns1:issenderemail> <ns1:issendersms>false</ns1:issendersms> </ns1:notificationdelivered> <ns1:notificationexception> <ns1:isreceiveremail>false</ns1:isreceiveremail> <ns1:isreceiversms>false</ns1:isreceiversms> <ns1:issenderemail>false</ns1:issenderemail> <ns1:issendersms>false</ns1:issendersms> </ns1:notificationexception> <ns1:notificationnew> <ns1:isreceiveremail>false</ns1:isreceiveremail> <ns1:isreceiversms>false</ns1:isreceiversms> <ns1:issenderemail>false</ns1:issenderemail> <ns1:issendersms>false</ns1:issendersms> </ns1:notificationnew> <ns1:notificationsent> <ns1:isreceiveremail>false</ns1:isreceiveremail> <ns1:isreceiversms>false</ns1:isreceiversms> <ns1:issenderemail>false</ns1:issenderemail> <ns1:issendersms>false</ns1:issendersms> </ns1:notificationsent> <ns1:options> <ns1:string>doplata_paliwowa</ns1:string> </ns1:options> <ns1:ordernumber>1z0vw7556892205956</ns1:ordernumber> <ns1:orderpickuptype>courier</ns1:orderpickuptype> <ns1:pickupdate>2010-04-12t00:00:00+02:00</ns1:pickupdate> <ns1:pickuptimefrom>12:00</ns1:pickuptimefrom> <ns1:pickuptimeto>15:00</ns1:pickuptimeto> <ns1:receiver> <ns1:addressline1>ul. Blabla 6</ns1:addressLine1> <ns1:addressline2/> <ns1:city>warszawa</ns1:city> <ns1:contactname>blabla</ns1:contactname> <ns1:countryid>0</ns1:countryid> <ns1:email>test@test.com</ns1:email> <ns1:name>b</ns1:name> <ns1:phone>123456789</ns1:phone> <ns1:postalcode>01-990</ns1:postalcode> <ns1:statecode ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschema- </ns1:receiver> <ns1:referencenumber>numer</ns1:referencenumber> <ns1:sender> <ns1:addressline1>ul. rtrttrt 6</ns1:addressLine1> <ns1:addressline2/> <ns1:city>warszawa</ns1:city> <ns1:contactname>ppp</ns1:contactname> <ns1:countryid>0</ns1:countryid> <ns1:email>test@test.com</ns1:email> <ns1:name>p</ns1:name> <ns1:phone>123456789</ns1:phone> <ns1:postalcode>02-222</ns1:postalcode> <ns1:statecode ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschema- </ns1:sender> <ns1:servicecode>ups_k_standard</ns1:servicecode> <ns1:shipments> <ns1:shipment> <ns1:dimension1 ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschema- R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 16/32
<ns1:dimension2 ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschemainstance"/> <ns1:dimension3 ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschemainstance"/> <ns1:options/> <ns1:position>1</ns1:position> <ns1:shipmenttypecode>pacz</ns1:shipmenttypecode> <ns1:shipmentvalue>100</ns1:shipmentvalue> <ns1:weight>3</ns1:weight> </ns1:shipment> </ns1:shipments> <ns1:waybillnumber ns2:nil="true" xmlns:ns2="http://www.w3.org/2001/xmlschemainstance"/> </ns1:order> <ns1:result> <ns1:messages/> </ns1:result> </ns1:return> </ns1:placeorderresponse> </soap:body> </soap:envelope> 2.1.4. Kody błędów Poniższa tabela zawiera zestawienie wartości kodów błędów zwracanych w PlaceOrderResponse/result/ messages/message/code Kod błędu API_KEY_ERROR ERR_COD_AMOUNT ERR_COD_COUNTRY ERR_DOMESTIC ERR_SERVICE LOGIN_FAILED NO_SERVICE REQ_ACCOUNT_NUMBER REQ_ADDRESS_LINE1 REQ_CITY REQ_COD_AMOUNT Znaczenie Nieprawidłowy klucz API. Niepoprawna kwota pobrania (ujemna lub zbyt duża). Do wybranego kraju nie można wysłać przesyłki pobraniowej. Jeśli wybrano przesyłkę krajową, krajem doręczenia musi być Polska. Wybrana usługa nie jest w stanie obsłużyć składanego zlecenia. Nieprawidłowy login i/lub hasło. Nie istnieje usługa o kodzie podanym w wywołaniu. Dla przesyłek pobraniowych wymagane jest podanie nr rachunku bankowego do zwrotu pobrania. Pierwsza linia adresu nie może być pusta. Miasto nie może być puste. Kwota pobrania nie może być pusta. R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 17/32
Kod błędu REQ_CONTACT_NAME REQ_CONTENTS REQ_COUNTRY REQ_NAME REQ_PHONE REQ_POSTAL_CODE REQ_POSITION REQ_WEIGHT REQ_DIMENSION Znaczenie Osoba kontaktowa nie może być pusta. Zawartość przesyłki nie może być pusta. Nie istnieje kraj o podanym identyfikatorze. Nazwa nadawcy/odbiorcy nie może być pusta. Telefon osoby kontaktowej nie może być pusty. Kod pocztowy nie może być pusty. Liczba porządkowa paczki w ramach zlecenia nie może być pusta. Waga paczki nie może być pusta. Wymiar paczki nie może być pusty. 2.2. getwaybilldocument Operacja getwaybilldocument służy do pobierania listu przewozowego. 2.2.1. Komunikaty wysyłane Ścieżka Typ Wymagane Opis WaybillRequest T Żądanie pobrania listu przewozowego WaybillRequest/authorizati on WaybillRequest/authorizati on/ apikey WaybillRequest/authorizati on/ login WaybillRequest/authorizati on/ password T Autoryzacja użytkownika T Klucz użytkownika do Apaczka Webservice API T Login użytkownika T Hasło użytkownika WaybillRequest/orderId Long T Id zamówienia R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 18/32
2.2.2. Komunikaty odbierane Ścieżka Typ Opis return return/result return/result/messages return/result/messages/message return/result/messages/message/ code List<Message> Odpowiedź pobierania listu przewozowego Rezultat operacji Lista komunikatów Komunikat Kod komunikatu return/result/messages/message/ description Opis komunikatu return/result/messages/message/ severity ERROR, INFO, WARN return/waybilldocument Dokument PDF zakodowany w base64 2.2.3. Przykład Żądanie: <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.pretius.com"> <soapenv:header/> <soapenv:body> <api:getwaybilldocument> <api:waybillrequest> <api:authorization> <api:apikey>apikeytest</api:apikey> <api:login>apitest</api:login> <api:password>apitest</api:password> </api:authorization> <api:orderid>189050</api:orderid> </api:waybillrequest> </api:getwaybilldocument> </soapenv:body> </soapenv:envelope> Odpowiedź: <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body> <ns1:getwaybilldocumentresponse xmlns:ns1="http://api.pretius.com"> <ns1:return> R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 19/32
<ns1:result> <ns1:messages/> </ns1:result> <ns1:waybilldocument>jvberi0xl </ns1:waybilldocument> </ns1:return> </ns1:getwaybilldocumentresponse> </soap:body> </soap:envelope> 2.3. getcollectivewaybilldocument Operacja getcollectivewaybilldocument służy do pobierania pliku pdf zawierającego listy przewozowe dla dowolnej liczby zleceń. 2.3.1. Komunikaty wysyłane Ścieżka Typ Wymagane Opis CollectiveWaybillRequest T Żądanie pobrania listu przewozowego CollectiveWaybillRequest/a uthorization CollectiveWaybillRequest/a uthorization/apikey CollectiveWaybillRequest/a uthorization/login CollectiveWaybillRequest/a uthorization/password T Autoryzacja użytkownika T Klucz użytkownika do Apaczka Webservice API T Login użytkownika T Hasło użytkownika WaybillRequest/orderIds T Lista id zleceń WaybillRequest/orderIds/lo ng Long przynajmniej 1 Id zlecenia 2.3.2. Komunikaty odbierane Ścieżka Typ Opis return Odpowiedź pobierania listu przewozowego R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 20/32
Ścieżka Typ Opis return/result return/result/messages return/result/messages/message return/result/messages/message/ code List<Message> Rezultat operacji Lista komunikatów Komunikat Kod komunikatu return/result/messages/message/ description Opis komunikatu return/result/messages/message/ severity ERROR, INFO, WARN return/waybilldocument Dokument PDF zakodowany w base64 2.3.3. Przykład Żądanie: <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.pretius.com"> <soapenv:header/> <soapenv:body> <api:getcollectivewaybilldocument> <api:collectivewaybillrequest> <api:authorization> <api:apikey>apikeytest</api:apikey> <api:login>apitest</api:login> <api:password>apitest</api:password> </api:authorization> <api:orderids> <api:long>1</api:long> <api:long>2</api:long> </api:orderid> </api:collectivewaybillrequest> </api:getcollectivewaybilldocument> </soapenv:body> </soapenv:envelope> Odpowiedź: <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body> <ns1:getwaybilldocumentresponse xmlns:ns1="http://api.pretius.com"> <ns1:return> <ns1:result> <ns1:messages/> </ns1:result> <ns1:waybilldocument>jvberi0xl </ns1:waybilldocument> </ns1:return> </ns1:getwaybilldocumentresponse> </soap:body> R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 21/32
</soap:envelope> 2.4. getcollectiveturnincopydocument Operacja getcollectiveturnincopydocument służy do pobierania pliku pdf zawierającego potwierdzenia nadania dowolnej liczby zleceń. 2.4.1. Komunikaty wysyłane Ścieżka Typ Wymagane Opis CollectiveTurnInCopyRequest T Żądanie pobrania potwierdzeń nadania CollectiveTurnInCopyRequest /authorization CollectiveTurnInCopyRequest /authorization/apikey CollectiveTurnInCopyRequest /authorization/login CollectiveTurnInCopyRequest /authorization/password CollectiveTurnInCopyRequest /orderids T Autoryzacja użytkownika T Klucz użytkownika do Apaczka Webservice API T Login użytkownika T Hasło użytkownika T Lista id zleceń CollectiveTurnInCopyRequest /orderids/long Long przynajmniej 1 Id zlecenia 2.4.2. Komunikaty odbierane Ścieżka Typ Opis getcollectiveturnincopydocumentre sponse/return Odpowiedź pobierania potwierdzeń nadania getcollectiveturnincopydocumentre sponse/return/result Rezultat operacji R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 22/32
Ścieżka Typ Opis getcollectiveturnincopydocumentre sponse/return/result/messages getcollectiveturnincopydocumentre sponse/return/result/messages/mes sage List<Message> Lista komunikatów Komunikat getcollectiveturnincopydocumentre sponse/return/result/messages/mes sage/code Kod komunikatu getcollectiveturnincopydocumentre sponse/return/result/messages/mes sage/description Opis komunikatu getcollectiveturnincopydocumentre sponse/return/result/messages/mes sage/severity ERROR, INFO, WARN getcollectiveturnincopydocumentre sponse/return/turnincopydocument Dokument PDF zakodowany w base64 2.4.3. Przykład Żądanie: <soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.pretius.com"> <soapenv:header/> <soapenv:body> <api:getcollectiveturnincopydocument> <api:collectiveturnincopyrequest> <api:authorization> <api:apikey>api_key_123</api:apikey> <api:login>apitest</api:login> <api:password>apitest</api:password> </api:authorization> <api:orderids> <api:long>1</api:long> <api:long>2</api:long> </api:orderids> </api:collectiveturnincopyrequest> </api:getcollectiveturnincopydocument> </soapenv:body> </soapenv:envelope> Odpowiedź: <soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:body> <ns1:getcollectiveturnincopydocumentresponse xmlns:ns1="http://api.pretius.com"> <ns1:return> <ns1:result> <ns1:messages/> </ns1:result> <ns1:turnincopydocument>jvberi...</ns1:turnincopydocument> </ns1:return> </ns1:getcollectiveturnincopydocumentresponse> </soap:body> </soap:envelope> R2G Polska Niemcewicza 7/9 lok 100,02-022 Warszawa, www.apaczka.pl 23/32