dokumentacja API wersja 2.06 / 220313 1
Spis treści WSTĘP... 6 INTEGRACJA Z SENDITAPI... 6 POLITYKA KLUCZY API... 6 SANDBOX SENDITAPI... 7 METODY SENDITAPI... 7 ODPOWIEDZI METOD... 7 STRUKTURY... 8 PRZESYŁANIE HASŁA... 8 HASH UŻYTKOWNIKA... 9 FILTROWANIE WYNIKÓW... 9 NAZWY OPERATORÓW... 9 WALIDACJA PRZESYŁANYCH PÓL... 9 Nazwa adresu... 9 Nazwa i numer ulicy... 9 Polski kod pocztowy... 10 Zagraniczny kod pocztowy... 10 Nazwa nadawcy - odbiorcy / Imię i nazwisko... 10 Nazwa miasta... 10 Numer telefonu... 10 Osoba kontaktowa... 10 PROCES SKŁADANIA ZAMÓWIENIA... 10 PARAMETRY WYMAGANE PRZY RÓZNYCH RODZAJACH PRZESYŁEK... 11 Przesyłka paczkowa (nie dotyczy InPost)... 11 Przesyłka paczkowa (dotyczy tylko InPost)... 11 Przesyłka paletowa... 11 GRUPA USER... 12 2
SIUserLogin... 12 STRUserData... 12 SIGetUser... 13 STRUserListData... 14 STRAddress... 14 SIUserField... 15 GRUPA ADDRESS... 16 SIGetAddress... 16 SIAddressAdd... 16 SIAddressDelete... 17 SIAddressList... 17 STRAddressConditions... 18 STRAddressList... 18 GRUPA ORDER... 19 SIServicesCheck... 19 STRServicesList... 19 SIPackCategory... 20 STRCategory... 20 SIOrderRate... 21 STROrderData... 21 STRPricing... 23 STROrderAddress... 24 STRProducts... 24 STRSizesData... 25 STRTotal... 25 STRRateResult... 25 STRAlerts... 26 3
STRAlertTarget... 26 STRAlertType... 26 STRNSTData... 26 SIOrderSave... 27 SIOrderConfirm... 27 SIOrderConfirmList... 28 SIGetOrder... 29 STROrderOutput... 29 STRHistory... 32 SIOrderList... 32 STROrderConditions... 33 STROrderList... 33 SIOrderStatus... 33 STROrderStatus... 34 SIOrderPDF... 34 GRUPA INPOST... 36 SIInpostMachines... 36 STRMachines... 36 STRMachineData... 37 SIInpostNearestMachines... 37 GRUPA PROTOCOL... 38 SIProtocolGenerate... 38 STRProtocolsGen... 38 SIGetProtocol... 39 STRProtocolData... 39 SIProtocolList... 40 STRProtocolConditions... 41 4
STRProtocolsList... 41 SIProtocolPDF... 41 KODY BŁĘDÓW... 42 TERMINY ODBIORU... 47 KODY USŁUG... 48 KODY PRODUKTÓW... 48 STATUSY ZLECEŃ... 50 5
WSTĘP Platforma Sendit.pl pozwala szybko i wygodnie wycenić przesyłkę kurierską, zamówić usługę wybranej firmy przewozowej, zapłacić za zamówienie, obserwować status przesyłki oraz historię dotychczasowych zamówień. SenditAPI jest usługą sieciową, dzięki której można korzystać z większości możliwości platformy Sendit.pl w swoim własnym systemie. Usługa SenditAPI oparta jest na protokole SOAP i zdefiniowana za pomocą języka WSDL, dzięki czemu jest łatwa do zaimplementowania i niezależna od platformy wykorzystywanej po stronie klienta. Adres, pod którym można znaleźć SenditAPI to https://api.sendit.pl/webservice.php Specyfikacja WSDL dostępna jest pod adresem https://api.sendit.pl/webservice.php?wsdl INTEGRACJA Z SENDITAPI Dostęp do metod SenditAPI wymaga podania unikalnego klucza API. Użytkownicy zarejestrowani w serwisie Sendit.pl mogą złożyć wniosek o przydzielenie klucza za pomocą formularza na stronie http://sendit.pl/kontakt (kontakt w kategorii: Wniosek o klucz SenditAPI). Wydanie Użytkownikowi klucza SenditAPI uwarunkowane jest zaakceptowaniem przez niego Regulaminu usługi SenditAPI dostępnego pod adresem http://sendit.pl/regulamin-senditapi. Wszystkie połączenia do SenditAPI muszą być szyfrowane za pomocą protokołu SSL. POLITYKA KLUCZY API Klucz API jest unikalnym ciągiem znaków jednoznacznie identyfikującym jego właściciela. Wielkość znaków w kluczu ma znaczenie i tylko prawidłowo podany klucz pozwala na dostęp do SenditAPI. Klucz API może otrzymać każdy zarejestrowany użytkownik Sendit.pl, posiadający w pełni aktywowane i nie zablokowane konto w serwisie. Do obowiązku użytkownika należy zadbanie o bezpieczne przechowywanie klucza, użytkownik nie może też udostępniać swojego klucza stronie trzeciej i ponosi wszelką odpowiedzialność za jego wykorzystanie w celach sprzecznych z obowiązującym prawem oraz regulaminem usługi SenditAPI oraz regulaminem Sendit.pl. Klucz API jest bezpośrednio powiązany z kontem użytkownika Sendit.pl, co oznacza, że jego właściciel może mieć dostęp poprzez SenditAPI tylko i wyłącznie do własnych zasobów Sendit.pl, a wszelkie zmiany cenowo rabatowe Sendit.pl będą dotyczyły również metod SenditAPI. Z jednego klucza API można wykonać maksymalnie 20 zapytań na sekundę. Po przekroczeniu tego limitu na klucz nakładana jest automatyczna blokada zdejmowana po upływie 5 minut. Każdy klucz ważny jest bezterminowo. Szczegółowe zasady Polityki usługi SenditAPI znajdują się w Regulaminie SenditAPI, dostępnym na stronie http://sendit.pl/regulamin-senditapi. 6
SANDBOX SENDITAPI Serwis Sendit.pl udostępnia swoim użytkownikom środowisko testowe (sandbox), w którym możliwe jest sprawdzenie poprawności działania stworzonych samodzielnie, a w oparciu o usługę SenditAPI, aplikacji użytkownika. Środowisko to dostępne jest pod adresem: http://sandbox.sendit.pl Sandbox SenditAPI jest nie tylko wydzieloną kopią funkcjonalności serwisu Sendit.pl, ale również środowiskiem symulującym, w oparciu o dostępne narzędzia Partnerów serwisu, funkcjonalności powiązane z serwisem a dostarczane przez zewnętrznych partnerów np. systemy obsługi zleceń kurierów, płatności itp. Rejestracja w serwisie Sandbox SenditAPI jest dokonywana automatycznie w momencie wydania klucza SenditAPI. Informacje potrzebne do zalogowania są wysyłane na adres e-mail konta Sendit.pl. Adres, pod którym można znaleźć Sandbox SenditAPI to https://api-sandbox.sendit.pl/webservice.php Specyfikacja WSDL dostępna jest pod adresem https://api-sandbox.sendit.pl/webservice.php?wsdl METODY SENDITAPI Nazwy wszystkich metod SenditAPI zaczynają się od liter SI. Kolumna oznaczona * wskazuje czy parametr jest wymagany. Wszystkie opisy wskazujące na kod ISO kraju oznaczają użycie standardu ISO 3166-1 (kod podany małymi literami dotyczy języka metody, w pozostałych przypadkach zawsze używamy wielkich liter). Kod ISO waluty oznacza użycie standardu ISO 4217. ODPOWIEDZI METOD Każda z metod SenditAPI odpowiada w jeden z dwóch sposobów. W przypadku błędu: ODPOWIEDŹ typu błąd Parametr Typ Wartość Opis status STR error Identyfikator błędnej odpowiedzi message STR zależna od błędu Opis błędu w wybranym języku code STR zależna od błędu Kod błędu 7
W przypadku sukcesu: ODPOWIEDŹ typu sukces Parametr Typ Wartość Opis status STR success Identyfikator poprawnej odpowiedzi...... Kolejne parametry opisane przy konkretnych metodach Powyższe należy uwzględnić przy projektowaniu własnej platformy opartej o SenditAPI. STRUKTURY Na potrzeby tej dokumentacji struktury użyte w metodach zostały opisane własnymi nazwami zaczynającymi się od liter STR. Szczegółowe opisy parametrów zawartych w strukturach można znaleźć po przejściu do odpowiedniej tabeli z zawartością struktury. PRZESYŁANIE HASŁA Hasło użytkownika Sendit.pl musi być zakodowane przed przesłaniem. SenditAPI nie pozwala na przesyłanie haseł otwartym tekstem. Hasło, identycznie jak to ma miejsce w przypadku działania metody dologinenc webapi Allegro (http://allegro.pl/webapi/documentation.php/show/id,83), musi być najpierw potraktowane funkcją skrótu SHA-256, a następnie zakodowane za pomocą base64. W przypadku hasła konta zarejestrowanego danymi Allegro należy pamiętać, aby kodować jedynie pierwsze 16 znaków hasła, zgodnie z wyjaśnieniem podanym w pkt. 6 FAQ webapi Allegro (http://allegro.pl/webapi/faq.php#faq_5). Przykład (PHP): $password_input = 'hasło użytkownika'; if ( function_exists( 'hash') && in_array( 'sha256', hash_algos())) { $password_output = hash( 'sha256', $password_input, true); } elseif ( function_exists( 'mhash') && is_int( MHASH_SHA256)) { $password_output = mhash( MHASH_SHA256, $password_input); } $password_output = base64_encode( $password_output); 8
HASH UŻYTKOWNIKA Hash użytkownika (userhash) jest ciągiem znaków identyfikującym sesję logowania użytkownika i musi być przesłany jako parametr w każdej z metod SenditAPI (oprócz SIUserLogin). userhash wygasa po upływie 30 minut od ostatniego wywołania metody z jego użyciem, każde wcześniejsze użycie przedłuża jego ważność na kolejne 30 minut. Hash automatycznie wygasa po 24 godzinach istnienia niezależnie od podtrzymujących go metod. Metody muszą być wywoływane przez tego samego użytkownika, który się zalogował weryfikowany jest adres IP. FILTROWANIE WYNIKÓW Metody pozwalające na filtrowanie wyników mają wbudowane trzy parametry: operand, operator i value. Użycie którejkolwiek z nich spowoduje, że wszystkie trzy będą brane pod uwagę przy filtrowaniu wyników. Operand przyjmuje zawsze jako wartość nazwę jednego z pól dostępnych w strukturze zwracanej przez metodę grupy pobierającej dany obiekt. Operator może mieć wyłącznie jedną z następujących wartości: '<', '<=', '>', '>=', 'LIKE', '=', '!= ' Value przyjmuje wartość do przyrównania i nie jest wymagana w przypadku trzech ostatnich wartości operator. Dozwolone znaki value to litery, cyfry, spacja, przecinek, kropka, myślnik i ukośnik. W przypadku użycia operatora LIKE wartość pola value zostanie automatycznie otoczona znakami '%'. Całość zostaje użyta do przefiltrowania wyników zwracanych przez metodę. Dla przykładu, ustawienie operand równe 'addressid', operator równe '>', a value równe '10' zostanie oczywiście zinterpretowane jako addressid > 10. NAZWY OPERATORÓW SenditAPI oferuje usługi wszystkich operatorów dostępnych w Sendit.pl. W chwili obecnej są to: DPD, UPS oraz InPost. Nazwy operatorów w parametrach podajemy małymi literami. WALIDACJA PRZESYŁANYCH PÓL SenditAPI w przypadku niektórych pól pozwala na przesłanie tylko ograniczonego zestawu możliwych znaków. Dane otrzymywane i wysyłane przez SenditAPI kodowane są za pomocą UTF-8. Dostępne znaki przedstawione są poniżej: Nazwa adresu Litery, cyfry, przecinek, kropka, spacja, myślnik, 2 255 znaków Nazwa i numer ulicy Litery, cyfry, przecinek, kropka, spacja, myślnik, ukośnik, 3 35 znaków 9
Polski kod pocztowy Standardowy układ XX-XXX, 6 znaków Zagraniczny kod pocztowy Litery, cyfry, 1 30 znaków Nazwa nadawcy - odbiorcy / Imię i nazwisko Litery, cyfry, przecinek, kropka, spacja, myślnik, ukośnik, 3 35 znaków Nazwa miasta Litery, przecinek, kropka, spacja, myślnik, ukośnik, odwrotny ukośnik, 2 30 znaków Numer telefonu Cyfry, plus, 9 15 znaków Osoba kontaktowa Litery, cyfry, kropka, spacja, myślnik, 3 35 znaków PROCES SKŁADANIA ZAMÓWIENIA Na proces składania zamówienia składa się kilka kroków, które zostały przedstawione graficznie poniżej. 10
PARAMETRY WYMAGANE PRZY RÓZNYCH RODZAJACH PRZESYŁEK SenditAPI obsługuje wszystkie typy przesyłek dostępnych na Sendit.pl, jednakże każdy z tych typów wymaga przesłania odpowiednich parametrów, przekazywanych w strukturze STROrderData. Poniżej przedstawione są wszystkie wymagania. Przesyłka paczkowa (nie dotyczy InPost) Pola adresowe: wszystkie zaczynające się od 'sender' i 'receiver' z wyjątkiem 'receiveremail', które można przesłać puste. Pola kategorii paczek: przynajmniej jedno z pól zaczynających się od 'kp' (od 'kpk' do 'kp70') musi mieć wartość większą niż 0. Suma wszystkich paczek jednego zlecenia nie może być większa niż 30. Przesyłka paczkowa (dotyczy tylko InPost) Pola adresowe: wszystkie zaczynające się od 'sender' oraz 'receiverzipcode', 'receiveremail' i 'receiverphonenumber'. Pola kategorii paczek: wszystkie paczki InPost muszą być podane w polu 'sizesdata' za pomocą struktury STRSizesData. Pola paczkomatów: pola 'senderbox', 'preferredbox' i 'secondarybox' muszą być uzupełnione. 'secondarybox' można przesłać z wartością 'brak'. Przesyłka paletowa Pola adresowe: jak w przypadku przesyłki paczkowej (innej niż InPost). Pola paletowe: 'kpal' musi być ustawione na 1, pola 'palletheight' i 'palletweight' muszą być uzupełnione. 11
GRUPA USER Metody grupy USER w SenditAPI pozwalają wyłącznie na odczyt danych zawartych na koncie Sendit.pl. Czynności takie jak rejestracja, aktywacja konta bądź adresu email muszą być przeprowadzone bezpośrednio w Sendit.pl. SIUserLogin Metoda pozwala na zalogowanie użytkownika w systemie i uzyskanie userhash niezbędnego przy pozostałych metodach. SIUserLogin Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 login STR TAK Login używany w Sendit.pl 3 password STR TAK Hash hasła używanego w Sendit.pl (patrz PRZESYŁANIE HASŁA) 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIUserLogin: ODPOWIEDŹ userhash STR Hash użytkownika (patrz HASH UŻYTKOWNIKA) usermaindata STRUKTURA Dane użytkownika (patrz STRUKTURA STRUserData) STRUserData Struktura: STRUserData userid INT ID użytkownika dateadded INT Data rejestracji użytkownika (znacznik czasu) userlogin STR Login użytkownika useremail STR Aktywny adres email użytkownika lastlogin INT Data ostatniego logowania użytkownika (znacznik czasu) firstname STR Imię użytkownika 12
surname STR Nazwisko użytkownika companyname STR Nazwa firmy companynip INT NIP firmy phone STR Numer telefonu użytkownika activationdate INT Data aktywacji konta użytkownika (znacznik czasu) blockedstatus INT Flaga blokady konta (0 1) blockeddescription STR Powód blokady konta addaddressstatus INT Flaga konieczności dodania adresu głównego (0 1) updatedatastatus INT Flaga konieczności aktualizacji danych (0 1) changepasswordstatus INT Flaga konieczności zmiany hasła (0 1) standingorder INT Flaga włączonego zlecenia stałego odbioru (0 1) bankaccount STR Numer konta bankowego invoicestatus INT Flaga wystawiania faktur (0 1) paymenttype STR Rodzaj płatności (post pre) termsstatus INT Flaga akceptacji regulaminu (0 1) postpaidready INT Flaga posiadania danych wymaganych przy postpaid (0 1) SIGetUser Metoda pozwala na pobranie danych użytkownika i opcjonalne (getaddress = 1) pobranie adresu głównego i korespondencyjnego ( o ile istnieją). SIGetUser Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 getaddress INT NIE 0 Flaga pobrania adresu głównego i korespondencyjnego (0 1) 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) 13
SIGetUser: ODPOWIEDŹ userdata STRUKTURA Dane użytkownika (patrz STRUKTURA STRUserListData) STRUserListData Struktura: STRUserListData maindata STRUKTURA Główne dane użytkownika (patrz STRUKTURA STRUserData) mainaddress STRUKTURA Adres główny użytkownika (patrz STRUKTURA STRAddress) forwardaddress STRUKTURA Adres korespondencyjny użytkownika (patrz STRUKTURA STRAddress) STRAddress Struktura: STRAddress addressid INT ID adresu addressname STR Nazwa adresu mainaddress INT Flaga adresu głównego (0 1) defaultshipment INT Flaga domyślnego adresu nadania (0 1) forwardaddress INT Flaga adresu korespondencyjnego (0 1) street STR Nazwa i numer ulicy zipcode STR Kod pocztowy city STR Miasto countrycode STR Kod ISO kraju phonenumber STR Numer telefonu contactperson STR Imię i nazwisko osoby kontaktowej username STR Imię i nazwisko właściciela adresu companyname STR Nazwa firmy powiązanej z adresem email STR Adres email powiązany z adresem 14
SIUserField Metoda pozwala na pobranie pojedynczego pola z danych użytkownika. SIGetUser Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 field STR TAK Nazwa pola (patrz STRUKTURA STRUserData) 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIGetUser: ODPOWIEDŹ fieldname STR Nazwa pobranego pola fieldvalue STR Wartość pobranego pola 15
GRUPA ADDRESS Metody grupy ADDRESS nie pozwalają na modyfikację adresu głównego użytkownika. SIGetAddress Metoda pozwala na pobranie pojedynczego adresu użytkownika z jego książki adresowej. Można pobrać adres zarówno korzystając z jego ID jak wyszukać adres oznaczony flagą: główny (1), korespondencyjny (2) lub domyślny nadawczy (3). SIGetAddress Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 addressid INT NIE 0 ID adresu 4 flag INT NIE 0 Flaga adresu (0 1 2 3) 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIGetAddress: ODPOWIEDŹ address STRUKTURA Dane adresowe (patrz STRUKTURA STRAddress) SIAddressAdd Metoda pozwala na dodanie adresu do książki adresowej. Podanie addressid lub addressname, które jest już zapisane pozwala na aktualizację adresu o odpowiednio wskazanym addressid lub użytym addressname. Metoda nie pozwala na ustawienie flagi mainaddress na innym adresie niż główny. SIAddressAdd Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 addressdata STRUKTURA TAK Dane adresowe (patrz STRUKTURA STRAddress) 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) 16
SIAddressAdd: ODPOWIEDŹ addressid INT ID dodanego lub zaktualizowanego adresu SIAddressDelete Metoda pozwala na usunięcie adresów z książki adresowej. Usunięcie adresu oznaczonego flagą mainaddress jest niemożliwe. Usunięcie adresu oznaczonego pozostałymi flagami spowoduje ustawienie tych flag na adresie głównym. SIAddressDelete Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 addresses ARRAY TAK Tablica ID adresów 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIAddressList Metoda pozwala na pobranie listy adresów z książki adresowej spełniającej podane kryteria. SIAddressList Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 limit INT NIE 25 Limit wyników w jednym zapytaniu 4 offset INT NIE 0 Pozycja startowa 5 orderby STR NIE addressid Nazwa pola sortowania (patrz STRUKTURA STRAddress) 6 ordertype STR NIE desc Kierunek sortowania (desc asc) 7 operand STR NIE 8 operator STR NIE Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STRAddress) Rodzaj operacji filtrowania (patrz FILTROWANIE WYNIKÓW) 17
9 value STR NIE Wartość pola filtrowania (patrz FILTROWANIE WYNIKÓW) 10 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIAddressAdd: ODPOWIEDŹ conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STRAddressConditions) addresses STRUKTURA Lista wyników (patrz STRUKTURA STRAddressList) STRAddressConditions Struktura: STRAddressConditions operand STR Użyty parametr operand operator STR Użyty parametr operator value STR Użyty parametr value orderby STR Użyty parametr orderby ordertype STR Użyty parametr ordertype limit INT Użyty parametr limit offset INT Użyty parametr offset STRAddressList Struktura: STRAddressList count INT Ilość wyników bez ograniczenia limit list ARRAY STRUKTURA Tablica adresów (patrz STRUKTURA STRAddress) 18
GRUPA ORDER SIServicesCheck Metoda pozwala na sprawdzenie dostępnych w danej chwili dla kodu pocztowego nadawcy i odbiorcy usług poszczególnych operatorów. SIServicesCheck Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 senderzipcode STR TAK Kod pocztowy nadawcy 4 sendercountrycode STR TAK Kod ISO kraju nadawcy 5 receiverzipcode STR TAK Kod pocztowy odbiorcy 6 receivercountrycode STR TAK Kod ISO kraju odbiorcy 7 pallet INT NIE 0 Flaga przesyłki paletowej (0 1) 8 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIServicesCheck: ODPOWIEDŹ services ARRAY STRUKTURA Lista dostępnych usług (patrz STRUKTURA STRServicesList) STRServicesList Struktura: STRServicesList operator STR Nazwa operatora (patrz NAZWY OPERATORÓW) terms ARRAY Lista dostępnych terminów (patrz TERMINY ODBIORU) services ARRAY Lista dostępnych usług (patrz KODY USŁUG) error STR Kod błędu 19
SIPackCategory Metoda pozwala na ustalenie do której kategorii należy paczka na podstawie jej parametrów przestrzennych i wagowych. Należy pamiętać, że ta sama paczka może należeć do różnych kategorii w zależności od wybranego operatora. SIPackCategory Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 height INT TAK Wysokość paczki zaokrąglona w górę [cm] 4 width INT TAK Długość paczki zaokrąglona w górę [cm] 5 depth INT TAK Szerokość / głębokość paczki zaokrąglona w górę [cm] 6 weight INT TAK Waga paczki zaokrąglona w górę [kg] 7 countrycode STR NIE PL Kod ISO kraju odbiorcy 8 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIPackCategory: ODPOWIEDŹ category ARRAY STRUKTURA Kategorie paczki dla poszczególnych operatorów (patrz STRUKTURA STRCategory) STRCategory Struktura: STRCategory operator STR Nazwa operatora packcategory STR Kategoria paczki NST STR Flaga NST dla paczki o wskazanych wymiarach error STR Informacja o paczce nadmiarowej lub nadwagowej 20
SIOrderRate Metoda pozwala na wycenę przesyłki. Podanie parametru courier z nazwą operatora ograniczy wycenę tylko dla tego operatora. SIOrderRate Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 orderdata STRUKTURA TAK Dane przesyłki (patrz STRUKTURA STROrderData) 4 courier STR NIE Nazwa operatora 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIOrderRate: ODPOWIEDŹ pricing ARRAY STRUKTURA Wycena przesyłki (patrz STRUKTURA STRPricing) address STRUKTURA Użyte dane adresowe (patrz STRUKTURA STROrderAddress) STROrderData Struktura: STROrderData sendercountrycode STR Kod ISO kraju nadawcy senderemail STR Adres email nadawcy sendername STR Nazwa nadawcy senderstreet STR Nazwa i numer ulicy nadawcy sendercity STR Miasto nadawcy senderphonenumber STR Numer telefonu nadawcy senderzipcode STR Kod pocztowy nadawcy sendercontactperson STR Osoba kontaktowa nadawcy 21
receivercountrycode STR Kod ISO kraju odbiorcy receiveremail STR Adres email odbiorcy receivername STR Nazwa odbiorcy receiverstreet STR Nazwa i numer ulicy odbiorcy receivercity STR Miasto odbiorcy receiverphonenumber STR Numer telefonu odbiorcy receiverzipcode STR Kod pocztowy odbiorcy receivercontactperson STR Osoba kontaktowa odbiorcy kpk INT Ilość paczek kopertowych kp5 INT Ilość paczek do 5kg kp10 INT Ilość paczek do 10kg kp20 INT Ilość paczek do 20kg kp30 INT Ilość paczek do 30kg kp50 INT Ilość paczek do 50kg kp70 INT Ilość paczek do 70kg kpal INT Flaga przesyłki paletowej (0 1) palletheight INT Wysokość przesyłki paletowej zaokrąglona w górę [cm] palletweight INT Waga przesyłki paletowej zaokrąglona w górę [kg] sizesdata ARRAY STRUKTURA Dane paczek InPost (patrz STRUKTURA STRSizesData) senderbox STR Kod paczkomatu nadawczego InPost preferredbox STR Kod preferowanego paczkomatu odbiorczego InPost secondarybox STR Kod drugiego paczkomatu odbiorczego InPost COD FLOAT Wartość pobrania INS FLOAT Wartość dodatkowego ubezpieczenia ROD INT Flaga usługi ROD (patrz KODY USŁUG) (0 1) SRE INT Flaga usługi SRE (patrz KODY USŁUG) (0 1) SSE INT Flaga usługi SSE (patrz KODY USŁUG) (0 1) BYH INT Flaga usługi BYH (patrz KODY USŁUG) (0 1) 22
H24 INT Flaga usługi H24 (patrz KODY USŁUG) (0 1) deliverytime STR Kod terminu dostarczenia (patrz TERMINY ODBIORU) alerts NSTData STRUKTURA STRUKTURA Lista zamówionych powiadomień (patrz STRUKTURA STRAlerts) Lista paczek niestandardowych (patrz STRUKTURA STRNSTData) comment STR Komentarz do zlecenia / numer dokumentu sprzedaży content STR Opis zawartości invoiceflag INT Flaga wystawienia faktury (0 1) protocolflag INT Flaga automatycznego wygenerowania protokołu dla podanego zlecenia (0 1) STRPricing Struktura: STRPricing operator STR Nazwa operatora offline INT Flaga offline dla operatora (0 1) userpaymenttype STR Typ płatności użytkownika ( post pre) deliverytime STR Kod terminu dostarczenia (patrz TERMINY ODBIORU) products sizesdata ARRAY STRUKTURA ARRAY STRUKTURA Lista zamówionych usług (patrz STRUKTURA STRProducts) Wymiary paczek dla InPost (patrz STRUKTURA STRSizesData) total STRUKTURA Podsumowanie cenowe (patrz STRUKTURA STRTotal) result STRUKTURA Podsumowanie procesu wyceny (patrz STRUKTURA STRRateResult) 23
STROrderAddress Struktura: STROrderAddress sendercountrycode STR Kod ISO kraju nadawcy senderemail STR Adres email nadawcy sendername STR Nazwa nadawcy senderstreet STR Nazwa i numer ulicy nadawcy sendercity STR Miasto nadawcy senderphonenumber STR Numer telefonu nadawcy senderzipcode STR Kod pocztowy nadawcy sendercontactperson STR Osoba kontaktowa nadawcy receivercountrycode STR Kod ISO kraju odbiorcy receiveremail STR Adres email odbiorcy receivername STR Nazwa odbiorcy receiverstreet STR Nazwa i numer ulicy odbiorcy receivercity STR Miasto odbiorcy receiverphonenumber STR Numer telefonu odbiorcy receiverzipcode STR Kod pocztowy odbiorcy receivercontactperson STR Osoba kontaktowa odbiorcy STRProducts Struktura: STRProducts code STR Kod usługi (patrz KODY USŁUG) nett FLOAT Cena netto VAT FLOAT Wartość VAT gross FLOAT Cena brutto quantity INT Ilość sztuk 24
currency STR Kod ISO waluty description STR Opis usługi STRSizesData Struktura: STRSizesData width INT Długość paczki zaokrąglona w górę [cm] height INT Wysokość paczki zaokrąglona w górę [cm] depth INT Szerokość / głębokość paczki zaokrąglona w górę [cm] weight INT Waga paczki zaokrąglona w górę [kg] COD FLOAT Wartość pobrania INS INT Kategoria ubezpieczenia InPost w tysiącach ( 5 10 20) content STR Opis zawartości STRTotal Struktura: STRTotal nett FLOAT Cena netto VAT FLOAT Wartość VAT gross FLOAT Cena brutto quantity INT Ilość sztuk currency STR Kod ISO waluty STRRateResult Struktura: STRRateResult status INT Flaga poprawnej odpowiedzi (0 1) desc STR Opis odpowiedzi error STR Kod błędu 25
STRAlerts Struktura: STRAlerts receive courier advice deliver refuse STRUKTURA STRUKTURA STRUKTURA STRUKTURA STRUKTURA Powiadomienia o odbiorze przesyłki od nadawcy (patrz STRUKTURA STRAlertTarget) Powiadomienia o wydaniu przesyłki kurierowi / odbiorze w terminalu (patrz STRUKTURA STRAlertTarget) Powiadomienia o awizowaniu przesyłki (patrz STRUKTURA STRAlertTarget) Powiadomienia o doręczeniu przesyłki (patrz STRUKTURA STRAlertTarget) Powiadomienia o odmowie przyjęcia przesyłki (patrz STRUKTURA STRAlertTarget) STRAlertTarget Struktura: STRAlertTarget sender STRUKTURA Powiadomienia dla nadawcy (patrz STRUKTURA STRAlertType) receiver STRUKTURA Powiadomienia dla odbiorcy (patrz STRUKTURA STRAlertType) STRAlertType Struktura: STRAlertType sms INT Flaga powiadomienia typu sms (0 1) email INT Flaga powiadomienia typu email (0 1) STRNSTData Struktura: STRNSTData kpk INT Ilość niestandardowych paczek kopertowych kp5 INT Ilość niestandardowych paczek do 5kg 26
kp10 INT Ilość niestandardowych paczek do 10kg kp20 INT Ilość niestandardowych paczek do 20kg kp30 INT Ilość niestandardowych paczek do 30kg kp50 INT Ilość niestandardowych paczek do 50kg kp70 INT Ilość niestandardowych paczek do 70kg SIOrderSave Metoda pozwala na zapis zlecenia bez przekazywania go do operatora ( do późniejszego nadania). SIOrderSave Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 orderdata STRUKTURA TAK Dane przesyłki (patrz STRUKTURA STROrderData) 4 courier STR NIE Nazwa operatora 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIOrderSave: ODPOWIEDŹ pricing ARRAY STRUKTURA Wycena przesyłki (patrz STRUKTURA STRPricing) address STRUKTURA Użyte dane adresowe (patrz STRUKTURA STROrderAddress) ordernumber STR Numer zapisanego zlecenia SIOrderConfirm Metoda pozwala na zapis zlecenia i przekazanie go do operatora ( do wykonania). SIOrderConfirm Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 27
2 userhash STR TAK Hash sesji użytkownika 3 orderdata STRUKTURA TAK Dane przesyłki (patrz STRUKTURA STROrderData) 4 courier STR NIE Nazwa operatora 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIOrderConfirm: ODPOWIEDŹ ordernumbers ARRAY Numery zapisanych zleceń SIOrderConfirmList Metoda pozwala na przekazanie do wykonania listy uprzednio zapisanych zleceń. Każde z zapisanych zleceń zostanie wycenione ponownie i przekazane do wykonania z uaktualnioną wyceną. Aby zobaczyć jak wygląda aktualna wycena zlecenia jeszcze nie przekazanego do wykonania należy wywołać metodę SIGetOrder. SIOrderConfirmList Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 orders ARRAY TAK Tablica numerów zleceń 4 invoices INT NIE 0 Flaga wystawienia faktury (0 1) 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIOrderConfirmList: ODPOWIEDŹ ordernumbers ARRAY Numery zapisanych zleceń 28
SIGetOrder Metoda pozwala na pobranie danych zlecenia. Jeśli zlecenie nie zostało przekazane jeszcze do wykonania ( 'status' = 0), następuje ponowna wycena zamówionych usług. SIGetOrder Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 ordernumber STR TAK Numer zlecenia 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIGetOrder: ODPOWIEDŹ order STRUKTURA Dane zlecenia (patrz STRUKTURA STROrderOutput) history ARRAY STRUKTURA Historia zlecenia (patrz STRUKTURA STRHistory) STROrderOutput Struktura: STROrderOutput sendercountrycode STR Kod ISO kraju nadawcy senderemail STR Adres email nadawcy sendername STR Nazwa nadawcy senderstreet STR Nazwa i numer ulicy nadawcy sendercity STR Miasto nadawcy senderphonenumber STR Numer telefonu nadawcy senderzipcode STR Kod pocztowy nadawcy sendercontactperson STR Osoba kontaktowa nadawcy receivercountrycode STR Kod ISO kraju odbiorcy receiveremail STR Adres email odbiorcy 29
receivername STR Nazwa odbiorcy receiverstreet STR Nazwa i numer ulicy odbiorcy receivercity STR Miasto odbiorcy receiverphonenumber STR Numer telefonu odbiorcy receiverzipcode STR Kod pocztowy odbiorcy receivercontactperson STR Osoba kontaktowa odbiorcy kpk INT Ilość paczek kopertowych kp5 INT Ilość paczek do 5kg kp10 INT Ilość paczek do 10kg kp20 INT Ilość paczek do 20kg kp30 INT Ilość paczek do 30kg kp50 INT Ilość paczek do 50kg kp70 INT Ilość paczek do 70kg kpal INT Flaga przesyłki paletowej (0 1) palletheight INT Wysokość przesyłki paletowej zaokrąglona w górę [cm] palletweight INT Waga przesyłki paletowej zaokrąglona w górę [kg] packa INT Ilość paczek InPost typ A packb INT Ilość paczek InPost typ B packc INT Ilość paczek InPost typ C packcode STR Kod paczki InPost sizesdata ARRAY STRUKTURA Dane paczek InPost (patrz STRUKTURA STRSizesData) senderbox STR Kod paczkomatu nadawczego InPost preferredbox STR Kod preferowanego paczkomatu odbiorczego InPost secondarybox STR Kod drugiego paczkomatu odbiorczego InPost deliveringcode STR Kod odbiorczy InPost CODValue FLOAT Wartość pobrania INS FLOAT Wartość dodatkowego ubezpieczenia ROD INT Flaga usługi ROD (patrz KODY USŁUG) (0 1) 30
SRE INT Flaga usługi SRE (patrz KODY USŁUG) (0 1) SSE INT Flaga usługi SSE (patrz KODY USŁUG) (0 1) BYH INT Flaga usługi BYH (patrz KODY USŁUG) (0 1) H24 INT Flaga usługi H24 (patrz KODY USŁUG) (0 1) term STR Kod terminu dostarczenia (patrz TERMINY ODBIORU) alerts NSTData STRUKTURA STRUKTURA Lista zamówionych powiadomień (patrz STRUKTURA STRAlerts) Lista paczek niestandardowych (patrz STRUKTURA STRNSTData) comment STR Komentarz do zlecenia / numer dokumentu sprzedaży content STR Opis zawartości couriername STR Nazwa operatora LPNumber STR Numer listu przewozowego trackingcodes ARRAY Lista kodów trackingowych userid INT ID użytkownika status INT Status zlecenia orderhash STR Hash zlecenia orderid INT ID zlecenia ordernumber STR Numer zlecenia finalnett FLOAT Końcowa cena netto finalvat FLOAT Końcowa wartość VAT finalgross FLOAT Końcowa cena brutto finalquantity INT Łączna ilość currency STR Kod ISO waluty invoicedrawn INT Flaga wystawionej faktury (0 1) invoiceflag INT Flaga wystawienia faktury (0 1) protocolnumber STR Numer protokołu z tym zleceniem protocolflag INT Flaga automatycznego wygenerowania protokołu dla podanego zlecenia (0 1) 31
STRHistory Struktura: STRHistory statusid INT ID statusu statusnumber INT Numer statusu statusinfo STR Opis statusu date STR Data dodania statusu SIOrderList Metoda pozwala na pobranie listy zleceń spełniających podane kryteria. SIOrderList Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 type INT NIE 0 Typ zleceń: wszystkie, zapisane, realizowane, archiwalne (0 1 2 3) 4 limit INT NIE 25 Limit wyników w jednym zapytaniu 5 offset INT NIE 0 Pozycja startowa 6 orderby STR NIE orderid Nazwa pola sortowania (patrz STRUKTURA STROrderOutput) 7 ordertype STR NIE desc Kierunek sortowania (desc asc) 8 operand STR NIE 9 operator STR NIE Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STROrderOutput) Rodzaj operacji filtrowania (patrz FILTROWANIE WYNIKÓW) 10 value STR NIE Wartość pola filtrowania (patrz FILTROWANIE WYNIKÓW) 11 lang STR NIE pl Język odpowiedzi (kod ISO kraju) 32
SIOrderList: ODPOWIEDŹ conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STROrderConditions) orders STRUKTURA Lista wyników (patrz STRUKTURA STROrderList) STROrderConditions Struktura: STROrderConditions type INT Użyty parametr type operand STR Użyty parametr operand operator STR Użyty parametr operator value STR Użyty parametr value orderby STR Użyty parametr orderby ordertype STR Użyty parametr ordertype limit INT Użyty parametr limit offset INT Użyty parametr offset STROrderList Struktura: STROrderList count INT Ilość wyników bez ograniczenia limit list ARRAY STRUKTURA Tablica zleceń (patrz STRUKTURA STROrderOutput) SIOrderStatus Metoda pozwala na pobranie aktualnych statusów dla listy zleceń. SIOrderList Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 33
2 userhash STR TAK Hash sesji użytkownika 3 orders ARRAY TAK Tablica numerów zleceń 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIOrderStatus: ODPOWIEDŹ orders ARRAY STRUKTURA Lista wyników (patrz STRUKTURA STROrderStatus) STROrderStatus Struktura: STROrderStatus ordernumber STR Numer zlecenia statusnumber INT Numer statusu statusinfo STR Opis statusu SIOrderPDF Metoda pozwala na pobranie pliku PDF z listami przewozowymi do wydruku. SIOrderPDF Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 orders ARRAY TAK Tablica numerów zleceń 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) 34
SIOrderPDF: ODPOWIEDŹ orders ARRAY Tablica zleceń, które obejmuje otrzymany plik PDF pdf STR Plik PDF zakodowany w base64. 35
GRUPA INPOST Zlecenia operatora InPost wymagają podania kodu paczkomatu nadawczego i odbiorczego. W przypadku paczkomatu odbiorczego wymagane jest podanie tylko preferowanego drugi paczkomat odbiorczy jest paczkomatem zapasowym i wystarczy przesłać w tym polu 'brak', aczkolwiek podanie paczkomatu zapasowego pozwala na zabezpieczenie swojej przesyłki w sytuacjach awaryjnych. Poniższe metody pozwalają na uzyskanie kodów paczkomatów w poszczególnych miastach. SIInpostMachines Metoda pozwala na pobranie listy paczkomatów z opcjonalnym ograniczeniem do podanego kodu pocztowego. SIInpostMachines Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 zipcode STR NIE Kod pocztowy 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIInpostMachines: ODPOWIEDŹ machines STRUKTURA Lista paczkomatów (patrz STRUKTURA STRMachines) STRMachines Struktura: STRMachines count INT Ilość wyników list ARRAY STRUKTURA Tablica paczkomatów (patrz STRUKTURA STRMachineData) 36
STRMachineData Struktura: STRMachineData boxcode STR Kod paczkomatu zipcode STR Kod pocztowy paczkomatu city STR Miasto paczkomatu street STR Nazwa i numer ulicy paczkomatu COD INT Flaga możliwości wpłaty gotówkowej (0 1) info STR Uwagi dotyczące miejsca wpłaty SIInpostNearestMachines Metoda pozwala na pobranie listy paczkomatów znajdujących się najbliżej wskazanego kodu pocztowego. SIInpostNearestMachines Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 zipcode STR NIE Kod pocztowy 4 machines INT NIE 3 Ilość paczkomatów ( 1 10) 5 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIInpostNearestMachines: ODPOWIEDŹ machines INT Ilość paczkomatów list ARRAY STRUKTURA Tablica paczkomatów (patrz STRUKTURA STRMachineData) 37
GRUPA PROTOCOL Protokół, podpisany przez kuriera odbierające paczkę, jest dowodem jej nadania i podstawą reklamacji w Sendit.pl. SIProtocolGenerate Metoda pozwala na wygenerowanie protokołu dla podanych zleceń. Zlecenia, które są nadawane z tego samego miejsca znajdą się na wspólnym protokole. SIProtocolGenerate Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 orders ARRAY TAK Tablica numerów zleceń 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIProtocolGenerate: ODPOWIEDŹ protocols ARRAY STRUKTURA Tablica protokołów (patrz STRUKTURA STRProtocolsGen) STRProtocolsGen Struktura: STRProtocolsGen ordernumber STR Numer zlecenia protocolnumber STR Numer protokołu 38
SIGetProtocol Metoda pozwala na pobranie danych pojedynczego protokołu. SIGetProtocol Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 protocolnumber STR TAK Numer protokołu 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIProtocolGenerate: ODPOWIEDŹ protocol STRUKTURA Dane protokołu (patrz STRUKTURA STRProtocolData) STRProtocolData Struktura: STRProtocolData protocolid INT ID protokołu dateadded STR Data wygenerowania protokołu userid INT ID użytkownika protocolnumber STR Numer protokołu couriername STR Nazwa operatora sendername STR Nazwa nadawcy senderstreet STR Ulica i numer domu nadawcy senderzipcode STR Kod pocztowy nadawcy sendercity STR Miasto nadawcy sendercountrycode STR Kod ISO kraju nadawcy senderphonenumber STR Numer telefonu nadawcy senderemail STR Adres email nadawcy 39
sendercontactperson STR Osoba kontaktowa nadawcy orders ARRAY Tablica numerów zleceń protocolhash STR Hash protokołu SIProtocolList Metoda pozwala na pobranie listy protokołów spełniającej podane kryteria. SIProtocolList Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 limit INT NIE 25 Limit wyników w jednym zapytaniu 4 offset INT NIE 0 Pozycja startowa 5 orderby STR NIE protocolid Nazwa pola sortowania (patrz STRUKTURA STRProtocolData) 6 ordertype STR NIE desc Kierunek sortowania (desc asc) 7 operand STR NIE 8 operator STR NIE 9 value STR NIE Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STRProtocolData) Rodzaj operacji filtrowania (patrz FILTROWANIE WYNIKÓW) Wartość pola filtrowania (patrz FILTROWANIE WYNIKÓW) 10 lang STR NIE pl Język odpowiedzi (kod ISO kraju) SIProtocolList: ODPOWIEDŹ conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STRProtocolConditions) protocols STRUKTURA Lista wyników (patrz STRUKTURA STRProtocolsList) 40
STRProtocolConditions Struktura: STRProtocolConditions operand STR Użyty parametr operand operator STR Użyty parametr operator value STR Użyty parametr value orderby STR Użyty parametr orderby ordertype STR Użyty parametr ordertype limit INT Użyty parametr limit offset INT Użyty parametr offset STRProtocolsList Struktura: STRProtocolsList count INT Ilość wyników bez ograniczenia limit list ARRAY STRUKTURA Tablica protokołów (patrz STRUKTURA STRProtocolData) SIProtocolPDF Metoda pozwala na pobranie pliku PDF z protokołami do wydruku. SIProtocolPDF Lp. Parametr Typ * Domyślnie Opis 1 apikey STR TAK Klucz SenditAPI 2 userhash STR TAK Hash sesji użytkownika 3 protocols ARRAY TAK Tablica numerów protokołów 4 lang STR NIE pl Język odpowiedzi (kod ISO kraju) 41
SIProtocolPDF: ODPOWIEDŹ protocols ARRAY Tablica protokołów, które obejmuje otrzymany plik PDF pdf STR Plik PDF zakodowany w base64. KODY BŁĘDÓW KODY BŁĘDÓW Kod błędu ERR_ADDRESS_DEF_INTER ERR_ADDRESS_FORWARD_INTER ERR_ADDRESS_MAIN ERR_API_KEY ERR_API_KEY_BLOCKED ERR_API_KEY_OVERDUE ERR_AUTH ERR_BLOCKED_USER_CANT_INVOKE_METHOD ERR_COD_NO_BANK_NR ERR_COD_UNAVAILABLE ERR_COUNTRY ERR_DPD_INTER_OVERSIZE ERR_DPD_LP ERR_DPD_ZIP2_EXCLUDED ERR_DPD_ZIP2_NOT_DELIVER Opis błędu Zagraniczny adres nie może być domyślnym adresem nadawcy Zagraniczny adres nie może być domyślnym adresem korespondencyjnym Adres główny można ustawić tylko z poziomu Sendit.pl Podany klucz API jest nieprawidłowy Podany klucz API został zablokowany Upłynęła data ważności klucza API Błąd autoryzacji Konto użytkownika jest nieaktywne Przy składaniu zamówienia z opcją pobrania, wymagane jest uzupełnienie numeru konta w danych użytkownika Usługa pobrania niedostępna dla operatora Nieprawidłowa wartość pola kod kraju Max. dopuszczalna waga paczki w wysyłce międzynarodowej to 30kg Błąd generowania listu przewozowego DPD Kod odbiorcy nie jest obsługiwany z uwagi na dodatkowe opłaty celne DPD nie doręcza paczek do wybranej lokalizacji 42
ERR_FIELDNAME_NOT_EXISTS ERR_GENERATE_ORDER_PDF ERR_INPOST_INTERNATIONAL ERR_INPOST_MIX ERR_INSURANCE_UNAVAILABLE ERR_INTER_SENDER_COUNTRY ERR_INTER_TERM ERR_KP70_UNAVAILABLE ERR_LOAD_PRICELIST_FOR_OPERATOR ERR_MAX_INSURANCE_VALUE ERR_NO_DATABASE ERR_NO_MAIN_ADDRESS ERR_NO_ORDER_ID ERR_NO_ORDERS_SENT ERR_NO_PACKS ERR_NO_PROTOCOL_FILE ERR_NO_RESULTS ERR_NO_USER_ORDERS_FOUND ERR_NO_USER_PROTOCOLS_FOUND ERR_NST_STRUCTURE ERR_OPERATOR_BLOCKED_FOR_USER ERR_OPERATOR_NOT_CONNECTED ERR_OPERATOR_NOT_DEFINED_BOX_MACHINE ERR_OPERATOR_NOT_DEFINED_PAYMENT_DATA ERR_OPERATOR_UNAVAILABLE Identyfikator wybranego pola jest nieprawidłowy Wystąpił błąd podczas generowania listu przewozowego Wysyłka za granicę nie jest dostępna u operatora InPOST W jednym zleceniu nie można nadać jednocześnie paczek firmy InPost i innych operatorów Usługa dodatkowego ubezpieczenia jest niedostępna Nieprawidłowy kod kraju nadawcy Wybrany termin dostawy nie jest dostępny Zamówienie paczki o wadze do 70kg niedostępne u wybranego operatora Nie zdefiniowano cennika dla operatora Podana wartość ubezpieczona przekracza dostępny limit Brak połączenia z bazą danych Nie zdefiniowano głównego adresu konta Nie podano numeru zlecenia Błędna ilość zleceń przekazanych do sprawdzenia Brak zdefiniowanych przesyłek do wyceny Nie można wygenerować pliku protokołu Brak wyników do wyświetlenia Nie znaleziono zleceń dla wybranego użytkownika Wybrany protokół nie istnieje Nieprawidłowa ilość paczek niestandardowych Blokada operatora dla wybranego użytkownika Błąd podłączenia operatora do platformy Błędne lub nie zdefiniowane paczkomaty Brak definicji typu płatności dla operatora Operator niedostępny 43
ERR_ORDER_ALERT_SMS_OFF ERR_ORDER_DATA ERR_ORDER_DATA_ALERTS ERR_ORDER_DATA_BANK_ACCOUNT ERR_ORDER_DATA_BYH ERR_ORDER_DATA_EMPTY_ARRAY ERR_ORDER_DATA_H24 ERR_ORDER_DATA_NO_COURIER ERR_ORDER_DATA_NO_PACKS ERR_ORDER_DATA_R_CITY ERR_ORDER_DATA_R_COUNTRY ERR_ORDER_DATA_R_NAME ERR_ORDER_DATA_R_PERSON ERR_ORDER_DATA_R_PHONE ERR_ORDER_DATA_R_STREET ERR_ORDER_DATA_R_ZIP ERR_ORDER_DATA_ROD ERR_ORDER_DATA_S_CITY ERR_ORDER_DATA_S_COUNTRY ERR_ORDER_DATA_S_NAME ERR_ORDER_DATA_S_PERSON ERR_ORDER_DATA_S_PHONE ERR_ORDER_DATA_S_STREET ERR_ORDER_DATA_S_ZIP Usługa powiadomień SMS jest niedostępna Dane przekazane do obliczenia cen są nieprawidłowe Nieprawidłowe ustawienia powiadomień Podany numer konta jest nieprawidłowy Nieprawidłowa wartość pola do rąk własnych Przesłana lista zleceń jest pusta Nieprawidłowa wartość pola dostawa w 24h Nie wybrano operatora Nie wybrano żadnej paczki do wysłania Nieprawidłowa wartość pola miejscowość odbiorcy Nieprawidłowa wartość pola kraj odbiorcy Nieprawidłowa wartość pola imię odbiorcy Nieprawidłowa wartość pola osoba kontaktowa odbiorcy Nieprawidłowa wartość pola telefon odbiorcy Nieprawidłowa wartość pola ulica odbiorcy Nieprawidłowa wartość pola kod pocztowy odbiorcy Nieprawidłowa wartość pola zwrot dokumentów Nieprawidłowa wartość pola miejscowość nadawcy Nieprawidłowa wartość pola kraj nadawcy Nieprawidłowa wartość pola imię nadawcy Nieprawidłowa wartość pola osoba kontaktowa nadawcy Nieprawidłowa wartość pola telefon nadawcy Nieprawidłowa wartość pola ulica nadawcy Nieprawidłowa wartość pola kod pocztowy nadawcy 44
ERR_ORDER_DATA_S_ZIP_IMPORT ERR_ORDER_DATA_SRE ERR_ORDER_DATA_SSE ERR_ORDER_DATA_TOO_MANY_PACKS ERR_ORDER_GENERATE_DATA ERR_ORDER_HASH ERR_ORDER_NOT_EXIST ERR_ORDER_NR_EMPTY_ARRAY ERR_ORDER_PACK_CARRY_IN_FOR_MORE_PACKS ERR_ORDER_PALLET_WRONG_TERMIN ERR_ORDER_PRICELIST_DATA ERR_ORDER_SERVICE_24H ERR_ORDER_SERVICE_SSE ERR_ORDER_WRONG_RECEIVER_PHONE ERR_ORDER_WRONG_SENDER_PHONE ERR_ORDER_WRONG_TERM ERR_PACK_INS ERR_PACK_QUANTITY ERR_PACK_SIZE ERR_PACK_WEIGHT ERR_PALLET_HEIGHT_NOT_SET ERR_PALLET_HEIGHT_WRONG ERR_PALLET_MIX ERR_PALLET_QUANTITY Nieprawidłowy kod pocztowy nadawcy Nieprawidłowa wartość pola odbiór osobisty Nieprawidłowa wartość pola nadanie osobiste Za dużo paczek do wysłania Błąd obliczeń dla wybranego zamówienia Nieprawidłowy kod listu przewozowego Podane zlecenie nie istnieje Przesłana tablica numerów zleceń jest pusta Usługa niedostępna dla więcej niż 1 paczki w zleceniu Wybrany termin jest niedostępny Brak zdefiniowanego cennika dla użytkownika Usługa dostawy w 24h jest niedostępna Usługa dostarczenia własnego do terminalu jest niedostępna w podanym terminie Błędny numer komórkowy odbiorcy Błędny numer komórkowy nadawcy Wybrany termin odbioru jest niedostępny Nieprawidłowa wartość ubezpieczenia paczki do wysłania przez paczkomat InPost Podana ilość paczek jest nieprawidłowa Nieprawidłowy rozmiar paczki do wysłania przez paczkomat InPost Nieprawidłowa waga paczki do wysłania przez paczkomat InPost Nie podano wartości w polu wysokość palety Podana wysokość palety przekracza dostępny limit dla operatora W jednym zleceniu nie można nadać jednocześnie paczek i palety Podana ilość palet jest nieprawidłowa 45
ERR_PALLET_UNAVAILABLE ERR_PALLET_WEIGHT_NOT_SET ERR_PREPAID ERR_PROTOCOL_EMPTY_ARRAY ERR_PROTOCOL_INPOST ERR_PROTOCOL_NUMBER ERR_PW_SESSION ERR_READ_LP_PDF_FILE ERR_REQ_VARS ERR_RETURN_ORDER_NR_EMPTY_ARRAY ERR_SERVICE_UNAVAILABLE ERR_SET_ORDER_STATUS ERR_TMP_DPD_OFF ERR_TMP_UPS_OFF ERR_USER_ADDRESS_EXIST ERR_USER_DELETE_ADDRESS ERR_USER_DELETE_ADDRESS_EXIST ERR_USER_DELETE_ADDRESS_LAST ERR_USER_DELETE_ADDRESS_NOT_ARRAY ERR_USER_DELETE_ADDRESSES_LIST ERR_USER_IS_BLOCKED ERR_USER_NOT_FOUND ERR_USER_NOT_LOGGED ERR_USER_ORIGIN ERR_USER_STATUTE_AGREE Usługa wysyłki na palecie jest niedostępna Nie podano wartości w polu waga palety Tylko użytkownicy typu POSTPAID mogą przekazywać zlecenia do nadania Przesłana tablica numerów protokołów odbioru jest pusta Nie można wygenerować protokołu dla zlecenia InPost Nieprawidłowy numer protokołu Nieprawidłowe id sesji. Zaloguj się ponownie Wystąpił błąd podczas odczytu pliku Brak wymaganych parametrów Przetworzona tablica numerów zleceń jest pusta Wybrana usługa jest niedostępna Zmiana statusu zlecenia nie powiodła się Usługi międzynarodowe operatora DPD są tymczasowo niedostępne Usługi międzynarodowe operatora UPS są tymczasowo niedostępne Podany adres nie istnieje Podczas usuwania adresu wystąpił błąd Podany adres nie istnieje Nie można usunąć głównego adresu Lista adresów do usunięcia powinna być typu tablicowego Przekazane adresy do usunięcia są nieprawidłowe Dostęp użytkownika do serwisu jest zablokowany Nie znaleziono użytkownika Wystąpił błąd! Użytkownik nie jest zalogowany Niepoprawne IP wywołania Użytkownik nie zaakceptował regulaminu. 46
ERR_VARS ERR_WEBAPI_NOT_AVAIL ERR_WRONG_COD_VALUE ERR_WRONG_INS_VALUE ERR_WRONG_ORDER_ID ERR_WRONG_ORDER_STATUS ERR_WRONG_STATUS_NR ERR_ZIP ERR_ZIP_1 ERR_ZIP_2 ERR_ZIP_DPD1 ERR_ZIP_DPD2 ERR_ZIP_UPS1 ERR_ZIP_UPS2 ERROR_DPD_WEBSERVICE Nieprawidłowe parametry W chwili obecnej dostęp do API jest wyłączony. Prosimy spróbować później Niepoprawna wartość kwoty pobrania Niepoprawna wartość kwoty ubezpieczenia Błędny numer zlecenia Błędny status zlecenia przekazanego do realizacji Nieprawidłowa wartość dla statusu zlecenia Kod pocztowy jest nieprawidłowy Kod nadawcy jest nieprawidłowy Kod odbiorcy jest nieprawidłowy Kod nadawcy jest nieprawidłowy lub nieobsługiwany przez operatora DPD Kod odbiorcy jest nieprawidłowy lub nieobsługiwany przez operatora DPD Kod nadawcy jest nieprawidłowy lub nieobsługiwany przez operatora UPS Kod odbiorcy jest nieprawidłowy lub nieobsługiwany przez operatora UPS Wystąpił błąd u operatora DPD TERMINY ODBIORU SenditAPI używa następujących kodów określających terminy dostarczenia przesyłek: TERMINY ODBIORU Kod terminu t_normal t_morning t_tillnoon t_saturday Opis Standardowo Na rano Do południa W sobotę 47
KODY USŁUG SenditAPI używa następujących kodów określających usługi: KODY USŁUG Kod usługi COD INS ROD SRE SSE BYH H24 NST PRV Opis Pobranie Dodatkowe ubezpieczenie Zwrot dokumentów Odbiór własny Nadanie własne Doręczenie do rąk własnych Dostawa w 24 godziny Przesyłka niestandardowa Dostawa do mieszkania prywatnego KODY PRODUKTÓW SenditAPI używa następujących kodów określających produkty ( usługi zamówione): KODY PRODUKTÓW Kod produktu alert_email alert_sms fuel_charge kpal kpk kp5 kp10 kp20 kp30 Opis Powiadomienie email Powiadomienie SMS Opłata paliwowa Paleta Przesyłka kopertowa Przesyłka do 5kg Przesyłka do 10kg Przesyłka do 20kg Przesyłka do 30kg 48
kp50 kp70 nstd packa packb packc t_afternoon_kpk t_afternoon_kp5 t_afternoon_kp10 t_afternoon_kp20 t_afternoon_kp30 t_afternoon_kp50 t_afternoon_kp70 t_morning_kpk t_morning_kp5 t_morning_kp10 t_morning_kp20 t_morning_kp30 t_morning_kp50 t_morning_kp70 t_normal_kpk t_normal_kp5 t_normal_kp10 t_normal_kp20 t_normal_kp30 t_normal_kp50 t_normal_kp70 t_tillnoon_kpk Przesyłka do 50kg Przesyłka do 70kg Element niestandardowy Rozmiar A (8 x 38 x 64 cm) Rozmiar B (19 x 38 x 64 cm) Rozmiar C (41 x 38 x 64 cm) Dostawa po południu kopertowa Dostawa po południu do 5kg Dostawa po południu do 10kg Dostawa po południu do 20kg Dostawa po południu do 30kg Dostawa po południu do 50kg Dostawa po południu do 70kg Dostawa na rano kopertowa Dostawa na rano do 5kg Dostawa na rano do 10kg Dostawa na rano do 20kg Dostawa na rano do 30kg Dostawa na rano do 50kg Dostawa na rano do 70kg Przesyłka kopertowa Przesyłka do 5kg Przesyłka do 10kg Przesyłka do 20kg Przesyłka do 30kg Przesyłka do 50kg Przesyłka do 70kg Dostawa do południa kopertowa 49
t_tillnoon_kp5 t_tillnoon_kp10 t_tillnoon_kp20 t_tillnoon_kp30 t_tillnoon_kp50 t_tillnoon_kp70 Dostawa do południa do 5kg Dostawa do południa do 10kg Dostawa do południa do 20kg Dostawa do południa do 30kg Dostawa do południa do 50kg Dostawa do południa do 70kg STATUSY ZLECEŃ Zlecenia w SenditAPI przechodzą przez szereg kroków, które oznaczane są następującymi numerami statusów: STATUSY ZLECEŃ Numer statusu Opis ( nie dotyczy InPost) Opis ( InPost) 0 zlecenie zapisane zamówienie zapisane 1 realizowanie płatności realizowanie płatności 2 płatność odrzucona płatność odrzucona 3 płatność potwierdzona płatność potwierdzona 4 list przewozowy wygenerowany list przewozowy wygenerowany 5 zamówiono kuriera przygotowana do nadania w paczkomacie 6 zamówienie przyjęte zamówienie przyjęte 7 list przewozowy wygenerowany list przewozowy wygenerowany 8 list przewozowy wysłany do klienta list przewozowy wysłany do klienta 9 błąd przyjęcia zlecenia przez operatora błąd przyjęcia zlecenia przez operatora 10 oczekiwanie na kuriera gotowa do nadania w paczkomacie 11 przesyłka odebrana od klienta przesyłka nadana w paczkomacie 12 przesyłka w terminalu przesyłka w drodze 13 przesyłka w sortowni przesyłka w drodze 14 przesyłka w błędnym terminalu przesyłka w drodze 50