dokumentacja api - sendit.pl · senditapi oferuje usługi wszystkich operatorów dostępnych w...

1

dokumentacja API

wersja 2.06 / 220313

2

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

3

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

4

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

5

STRProtocolsList ........................................................................................................................................ 41

SIProtocolPDF ................................................................................................................................................ 41

KODY BŁĘDÓW .................................................................................................................................................. 42

TERMINY ODBIORU ........................................................................................................................................... 47

KODY USŁUG ...................................................................................................................................................... 48

KODY PRODUKTÓW ........................................................................................................................................... 48

STATUSY ZLECEŃ ................................................................................................................................................ 50

6

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 .

https://api.sendit.pl/webservice.php

https://api.sendit.pl/webservice.php?wsdl

http://sendit.pl/kontakt

http://sendit.pl/regulamin-senditapi

http://sendit.pl/regulamin-senditapi

7

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

http://sandbox.sendit.pl/

https://api-sandbox.sendit.pl/webservice.php

https://api-sandbox.sendit.pl/webservice.php?wsdl

8

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);

http://allegro.pl/webapi/faq.php#faq_5

9

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

10

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.

11

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.

12

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Ź

Parametr Typ Opis

userHash STR Hash użytkownika (patrz HASH UŻYTKOWNIKA)

userMainData STRUKTURA Dane użytkownika (patrz STRUKTURA STRUserData)

STRUserData

Struktura: STRUserData

Parametr Typ Opis

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

13

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



2 userHash STR TAK Hash sesji użytkownika

3 getAddress INT NIE 0 Flaga pobrania adresu głównego i korespondencyjnego (0|1)


14

SIGetUser: ODPOWIEDŹ

Parametr Typ Opis

userData STRUKTURA Dane użytkownika (patrz STRUKTURA STRUserListData)

STRUserListData

Struktura: STRUserListData

Parametr Typ Opis

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

Parametr Typ Opis

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

15

SIUserField

Metoda pozwala na pobranie pojedynczego pola z danych użytkownika.

SIGetUser




3 field STR TAK Nazwa pola (patrz STRUKTURA STRUserData)


SIGetUser: ODPOWIEDŹ

Parametr Typ Opis

fieldName STR Nazwa pobranego pola

fieldValue STR Wartość pobranego pola

16

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




3 addressID INT NIE 0 ID adresu

4 flag INT NIE 0 Flaga adresu (0|1|2|3)


SIGetAddress: ODPOWIEDŹ

Parametr Typ Opis

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




3 addressData STRUKTURA TAK Dane adresowe (patrz STRUKTURA STRAddress)


17

SIAddressAdd: ODPOWIEDŹ

Parametr Typ Opis

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




3 addresses ARRAY TAK Tablica ID adresów


SIAddressList

Metoda pozwala na pobranie listy adresów z książki adresowej spełniającej podane kryteria.

SIAddressList




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 Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STRAddress)

8 operator STR NIE Rodzaj operacji filtrowania (patrz FILTROWANIE WYNIKÓW)

18

9 value STR NIE Wartość pola filtrowania (patrz FILTROWANIE WYNIKÓW)


SIAddressAdd: ODPOWIEDŹ

Parametr Typ Opis

conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STRAddressConditions)

addresses STRUKTURA Lista wyników (patrz STRUKTURA STRAddressList)

STRAddressConditions

Struktura: STRAddressConditions

Parametr Typ Opis

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

Parametr Typ Opis

count INT Ilość wyników bez ograniczenia limit

list ARRAY STRUKTURA Tablica adresów (patrz STRUKTURA STRAddress)

19

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




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)


SIServicesCheck: ODPOWIEDŹ

Parametr Typ Opis

services ARRAY STRUKTURA Lista dostępnych usług (patrz STRUKTURA STRServicesList)

STRServicesList

Struktura: STRServicesList

Parametr Typ Opis

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

20

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




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


SIPackCategory: ODPOWIEDŹ

Parametr Typ Opis

category ARRAY STRUKTURA Kategorie paczki dla poszczególnych operatorów (patrz STRUKTURA STRCategory)

STRCategory

Struktura: STRCategory

Parametr Typ Opis

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

21

SIOrderRate

Metoda pozwala na wycenę przesyłki. Podanie parametru courier z nazwą operatora ograniczy wycenę

tylko dla tego operatora.

SIOrderRate




3 orderData STRUKTURA TAK Dane przesyłki (patrz STRUKTURA STROrderData)

4 courier STR NIE Nazwa operatora


SIOrderRate: ODPOWIEDŹ

Parametr Typ Opis

pricing ARRAY STRUKTURA Wycena przesyłki (patrz STRUKTURA STRPricing)

address STRUKTURA Użyte dane adresowe (patrz STRUKTURA STROrderAddress)

STROrderData

Struktura: STROrderData

Parametr Typ Opis

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

22

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






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)

23

H24 INT Flaga usługi H24 (patrz KODY USŁUG) (0|1)

deliveryTime STR Kod terminu dostarczenia (patrz TERMINY ODBIORU)

alerts STRUKTURA Lista zamówionych powiadomień (patrz STRUKTURA STRAlerts)

NSTData STRUKTURA 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

Parametr Typ Opis

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 ARRAY STRUKTURA Lista zamówionych usług (patrz STRUKTURA STRProducts)

sizesData ARRAY STRUKTURA Wymiary paczek dla InPost (patrz STRUKTURA STRSizesData)

total STRUKTURA Podsumowanie cenowe (patrz STRUKTURA STRTotal)

result STRUKTURA Podsumowanie procesu wyceny (patrz STRUKTURA STRRateResult)

24

STROrderAddress

Struktura: STROrderAddress

Parametr Typ Opis

















STRProducts

Struktura: STRProducts

Parametr Typ Opis

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

25

currency STR Kod ISO waluty

description STR Opis usługi

STRSizesData

Struktura: STRSizesData

Parametr Typ Opis

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)


STRTotal

Struktura: STRTotal

Parametr Typ Opis

nett FLOAT Cena netto

VAT FLOAT Wartość VAT

gross FLOAT Cena brutto

quantity INT Ilość sztuk


STRRateResult

Struktura: STRRateResult

Parametr Typ Opis

status INT Flaga poprawnej odpowiedzi (0|1)

desc STR Opis odpowiedzi

error STR Kod błędu

26

STRAlerts

Struktura: STRAlerts

Parametr Typ Opis

receive STRUKTURA Powiadomienia o odbiorze przesyłki od nadawcy (patrz STRUKTURA STRAlertTarget)

courier STRUKTURA Powiadomienia o wydaniu przesyłki kurierowi / odbiorze w terminalu (patrz STRUKTURA STRAlertTarget)

advice STRUKTURA Powiadomienia o awizowaniu przesyłki (patrz STRUKTURA STRAlertTarget)

deliver STRUKTURA Powiadomienia o doręczeniu przesyłki (patrz STRUKTURA STRAlertTarget)

refuse STRUKTURA Powiadomienia o odmowie przyjęcia przesyłki (patrz STRUKTURA STRAlertTarget)

STRAlertTarget

Struktura: STRAlertTarget

Parametr Typ Opis

sender STRUKTURA Powiadomienia dla nadawcy (patrz STRUKTURA STRAlertType)

receiver STRUKTURA Powiadomienia dla odbiorcy (patrz STRUKTURA STRAlertType)

STRAlertType

Struktura: STRAlertType

Parametr Typ Opis

sms INT Flaga powiadomienia typu sms (0|1)

email INT Flaga powiadomienia typu email (0|1)

STRNSTData

Struktura: STRNSTData

Parametr Typ Opis

kPK INT Ilość niestandardowych paczek kopertowych

kP5 INT Ilość niestandardowych paczek do 5kg

27






SIOrderSave

Metoda pozwala na zapis zlecenia bez przekazywania go do operatora ( do późniejszego nadania).

SIOrderSave







SIOrderSave: ODPOWIEDŹ

Parametr Typ Opis

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



28





SIOrderConfirm: ODPOWIEDŹ

Parametr Typ Opis

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




3 orders ARRAY TAK Tablica numerów zleceń

4 invoices INT NIE 0 Flaga wystawienia faktury (0|1)


SIOrderConfirmList: ODPOWIEDŹ

Parametr Typ Opis

orderNumbers ARRAY Numery zapisanych zleceń

29

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




3 orderNumber STR TAK Numer zlecenia


SIGetOrder: ODPOWIEDŹ

Parametr Typ Opis

order STRUKTURA Dane zlecenia (patrz STRUKTURA STROrderOutput)

history ARRAY STRUKTURA Historia zlecenia (patrz STRUKTURA STRHistory)

STROrderOutput

Struktura: STROrderOutput

Parametr Typ Opis











30







kPK INT Ilość paczek kopertowych







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)

31

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 STRUKTURA Lista zamówionych powiadomień (patrz STRUKTURA STRAlerts)

NSTData STRUKTURA Lista paczek niestandardowych (patrz STRUKTURA STRNSTData)

comment STR Komentarz do zlecenia / numer dokumentu sprzedaży


courierName STR Nazwa operatora

LPNumber STR Numer listu przewozowego

trackingCodes ARRAY Lista kodów trackingowych


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ść


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)

32

STRHistory

Struktura: STRHistory

Parametr Typ Opis

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




3 type INT NIE 0 Typ zleceń: wszystkie, zapisane, realizowane, archiwalne (0|1|2|3)



6 orderBy STR NIE orderID Nazwa pola sortowania (patrz STRUKTURA STROrderOutput)


8 operand STR NIE Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STROrderOutput)




33

SIOrderList: ODPOWIEDŹ

Parametr Typ Opis

conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STROrderConditions)

orders STRUKTURA Lista wyników (patrz STRUKTURA STROrderList)

STROrderConditions

Struktura: STROrderConditions

Parametr Typ Opis

type INT Użyty parametr type








STROrderList

Struktura: STROrderList

Parametr Typ Opis


list ARRAY STRUKTURA Tablica zleceń (patrz STRUKTURA STROrderOutput)

SIOrderStatus

Metoda pozwala na pobranie aktualnych statusów dla listy zleceń.

SIOrderList



34




SIOrderStatus: ODPOWIEDŹ

Parametr Typ Opis

orders ARRAY STRUKTURA Lista wyników (patrz STRUKTURA STROrderStatus)

STROrderStatus

Struktura: STROrderStatus

Parametr Typ Opis


statusNumber INT Numer statusu

statusInfo STR Opis statusu

SIOrderPDF

Metoda pozwala na pobranie pliku PDF z listami przewozowymi do wydruku.

SIOrderPDF






35

SIOrderPDF: ODPOWIEDŹ

Parametr Typ Opis

orders ARRAY Tablica zleceń, które obejmuje otrzymany plik PDF

pdf STR Plik PDF zakodowany w base64.

36

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




3 zipCode STR NIE Kod pocztowy


SIInpostMachines: ODPOWIEDŹ

Parametr Typ Opis

machines STRUKTURA Lista paczkomatów (patrz STRUKTURA STRMachines)

STRMachines

Struktura: STRMachines

Parametr Typ Opis

count INT Ilość wyników

list ARRAY STRUKTURA Tablica paczkomatów (patrz STRUKTURA STRMachineData)

37

STRMachineData

Struktura: STRMachineData

Parametr Typ Opis

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




3 zipCode STR NIE Kod pocztowy

4 machines INT NIE 3 Ilość paczkomatów ( 1 – 10)


SIInpostNearestMachines: ODPOWIEDŹ

Parametr Typ Opis

machines INT Ilość paczkomatów

list ARRAY STRUKTURA Tablica paczkomatów (patrz STRUKTURA STRMachineData)

38

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






SIProtocolGenerate: ODPOWIEDŹ

Parametr Typ Opis

protocols ARRAY STRUKTURA Tablica protokołów (patrz STRUKTURA STRProtocolsGen)

STRProtocolsGen

Struktura: STRProtocolsGen

Parametr Typ Opis


protocolNumber STR Numer protokołu

39

SIGetProtocol

Metoda pozwala na pobranie danych pojedynczego protokołu.

SIGetProtocol




3 protocolNumber STR TAK Numer protokołu


SIProtocolGenerate: ODPOWIEDŹ

Parametr Typ Opis

protocol STRUKTURA Dane protokołu (patrz STRUKTURA STRProtocolData)

STRProtocolData

Struktura: STRProtocolData

Parametr Typ Opis

protocolID INT ID protokołu

dateAdded STR Data wygenerowania protokołu


protocolNumber STR Numer protokołu

courierName STR Nazwa operatora


senderStreet STR Ulica i numer domu nadawcy






40


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






5 orderBy STR NIE protocolID Nazwa pola sortowania (patrz STRUKTURA STRProtocolData)


7 operand STR NIE Nazwa pola filtrowania (patrz FILTROWANIE WYNIKÓW i STRUKTURA STRProtocolData)




SIProtocolList: ODPOWIEDŹ

Parametr Typ Opis

conditions STRUKTURA Lista ustawionych kryteriów (patrz STRUKTURA STRProtocolConditions)

protocols STRUKTURA Lista wyników (patrz STRUKTURA STRProtocolsList)

41

STRProtocolConditions

Struktura: STRProtocolConditions

Parametr Typ Opis








STRProtocolsList

Struktura: STRProtocolsList

Parametr Typ Opis


list ARRAY STRUKTURA Tablica protokołów (patrz STRUKTURA STRProtocolData)

SIProtocolPDF

Metoda pozwala na pobranie pliku PDF z protokołami do wydruku.

SIProtocolPDF




3 protocols ARRAY TAK Tablica numerów protokołów


42

SIProtocolPDF: ODPOWIEDŹ

Parametr Typ Opis

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 Opis błędu

ERR_ADDRESS_DEF_INTER Zagraniczny adres nie może być domyślnym adresem nadawcy

ERR_ADDRESS_FORWARD_INTER Zagraniczny adres nie może być domyślnym adresem korespondencyjnym

ERR_ADDRESS_MAIN Adres główny można ustawić tylko z poziomu Sendit.pl

ERR_API_KEY Podany klucz API jest nieprawidłowy

ERR_API_KEY_BLOCKED Podany klucz API został zablokowany

ERR_API_KEY_OVERDUE Upłynęła data ważności klucza API

ERR_AUTH Błąd autoryzacji

ERR_BLOCKED_USER_CANT_INVOKE_METHOD Konto użytkownika jest nieaktywne

ERR_COD_NO_BANK_NR Przy składaniu zamówienia z opcją pobrania, wymagane jest uzupełnienie numeru konta w danych użytkownika

ERR_COD_UNAVAILABLE Usługa pobrania niedostępna dla operatora

ERR_COUNTRY Nieprawidłowa wartość pola kod kraju

ERR_DPD_INTER_OVERSIZE Max. dopuszczalna waga paczki w wysyłce międzynarodowej to 30kg

ERR_DPD_LP Błąd generowania listu przewozowego DPD

ERR_DPD_ZIP2_EXCLUDED Kod odbiorcy nie jest obsługiwany z uwagi na dodatkowe opłaty celne

ERR_DPD_ZIP2_NOT_DELIVER DPD nie doręcza paczek do wybranej lokalizacji

43

ERR_FIELDNAME_NOT_EXISTS Identyfikator wybranego pola jest nieprawidłowy

ERR_GENERATE_ORDER_PDF Wystąpił błąd podczas generowania listu przewozowego

ERR_INPOST_INTERNATIONAL Wysyłka za granicę nie jest dostępna u operatora InPOST

ERR_INPOST_MIX W jednym zleceniu nie można nadać jednocześnie paczek firmy InPost i innych operatorów

ERR_INSURANCE_UNAVAILABLE Usługa dodatkowego ubezpieczenia jest niedostępna

ERR_INTER_SENDER_COUNTRY Nieprawidłowy kod kraju nadawcy

ERR_INTER_TERM Wybrany termin dostawy nie jest dostępny

ERR_KP70_UNAVAILABLE Zamówienie paczki o wadze do 70kg niedostępne u wybranego operatora

ERR_LOAD_PRICELIST_FOR_OPERATOR Nie zdefiniowano cennika dla operatora

ERR_MAX_INSURANCE_VALUE Podana wartość ubezpieczona przekracza dostępny limit

ERR_NO_DATABASE Brak połączenia z bazą danych

ERR_NO_MAIN_ADDRESS Nie zdefiniowano głównego adresu konta

ERR_NO_ORDER_ID Nie podano numeru zlecenia

ERR_NO_ORDERS_SENT Błędna ilość zleceń przekazanych do sprawdzenia

ERR_NO_PACKS Brak zdefiniowanych przesyłek do wyceny

ERR_NO_PROTOCOL_FILE Nie można wygenerować pliku protokołu

ERR_NO_RESULTS Brak wyników do wyświetlenia

ERR_NO_USER_ORDERS_FOUND Nie znaleziono zleceń dla wybranego użytkownika

ERR_NO_USER_PROTOCOLS_FOUND Wybrany protokół nie istnieje

ERR_NST_STRUCTURE Nieprawidłowa ilość paczek niestandardowych

ERR_OPERATOR_BLOCKED_FOR_USER Blokada operatora dla wybranego użytkownika

ERR_OPERATOR_NOT_CONNECTED Błąd podłączenia operatora do platformy

ERR_OPERATOR_NOT_DEFINED_BOX_MACHINE Błędne lub nie zdefiniowane paczkomaty

ERR_OPERATOR_NOT_DEFINED_PAYMENT_DATA Brak definicji typu płatności dla operatora

ERR_OPERATOR_UNAVAILABLE Operator niedostępny

44

ERR_ORDER_ALERT_SMS_OFF Usługa powiadomień SMS jest niedostępna

ERR_ORDER_DATA Dane przekazane do obliczenia cen są nieprawidłowe

ERR_ORDER_DATA_ALERTS Nieprawidłowe ustawienia powiadomień

ERR_ORDER_DATA_BANK_ACCOUNT Podany numer konta jest nieprawidłowy

ERR_ORDER_DATA_BYH Nieprawidłowa wartość pola do rąk własnych

ERR_ORDER_DATA_EMPTY_ARRAY Przesłana lista zleceń jest pusta

ERR_ORDER_DATA_H24 Nieprawidłowa wartość pola dostawa w 24h

ERR_ORDER_DATA_NO_COURIER Nie wybrano operatora

ERR_ORDER_DATA_NO_PACKS Nie wybrano żadnej paczki do wysłania

ERR_ORDER_DATA_R_CITY Nieprawidłowa wartość pola miejscowość odbiorcy

ERR_ORDER_DATA_R_COUNTRY Nieprawidłowa wartość pola kraj odbiorcy

ERR_ORDER_DATA_R_NAME Nieprawidłowa wartość pola imię odbiorcy

ERR_ORDER_DATA_R_PERSON Nieprawidłowa wartość pola osoba kontaktowa odbiorcy

ERR_ORDER_DATA_R_PHONE Nieprawidłowa wartość pola telefon odbiorcy

ERR_ORDER_DATA_R_STREET Nieprawidłowa wartość pola ulica odbiorcy

ERR_ORDER_DATA_R_ZIP Nieprawidłowa wartość pola kod pocztowy odbiorcy

ERR_ORDER_DATA_ROD Nieprawidłowa wartość pola zwrot dokumentów

ERR_ORDER_DATA_S_CITY Nieprawidłowa wartość pola miejscowość nadawcy

ERR_ORDER_DATA_S_COUNTRY Nieprawidłowa wartość pola kraj nadawcy

ERR_ORDER_DATA_S_NAME Nieprawidłowa wartość pola imię nadawcy

ERR_ORDER_DATA_S_PERSON Nieprawidłowa wartość pola osoba kontaktowa nadawcy

ERR_ORDER_DATA_S_PHONE Nieprawidłowa wartość pola telefon nadawcy

ERR_ORDER_DATA_S_STREET Nieprawidłowa wartość pola ulica nadawcy

ERR_ORDER_DATA_S_ZIP Nieprawidłowa wartość pola kod pocztowy nadawcy

45

ERR_ORDER_DATA_S_ZIP_IMPORT Nieprawidłowy kod pocztowy nadawcy

ERR_ORDER_DATA_SRE Nieprawidłowa wartość pola odbiór osobisty

ERR_ORDER_DATA_SSE Nieprawidłowa wartość pola nadanie osobiste

ERR_ORDER_DATA_TOO_MANY_PACKS Za dużo paczek do wysłania

ERR_ORDER_GENERATE_DATA Błąd obliczeń dla wybranego zamówienia

ERR_ORDER_HASH Nieprawidłowy kod listu przewozowego

ERR_ORDER_NOT_EXIST Podane zlecenie nie istnieje

ERR_ORDER_NR_EMPTY_ARRAY Przesłana tablica numerów zleceń jest pusta

ERR_ORDER_PACK_CARRY_IN_FOR_MORE_PACKS Usługa niedostępna dla więcej niż 1 paczki w zleceniu

ERR_ORDER_PALLET_WRONG_TERMIN Wybrany termin jest niedostępny

ERR_ORDER_PRICELIST_DATA Brak zdefiniowanego cennika dla użytkownika

ERR_ORDER_SERVICE_24H Usługa dostawy w 24h jest niedostępna

ERR_ORDER_SERVICE_SSE Usługa dostarczenia własnego do terminalu jest niedostępna w podanym terminie

ERR_ORDER_WRONG_RECEIVER_PHONE Błędny numer komórkowy odbiorcy

ERR_ORDER_WRONG_SENDER_PHONE Błędny numer komórkowy nadawcy

ERR_ORDER_WRONG_TERM Wybrany termin odbioru jest niedostępny

ERR_PACK_INS Nieprawidłowa wartość ubezpieczenia paczki do wysłania przez paczkomat InPost

ERR_PACK_QUANTITY Podana ilość paczek jest nieprawidłowa

ERR_PACK_SIZE Nieprawidłowy rozmiar paczki do wysłania przez paczkomat InPost

ERR_PACK_WEIGHT Nieprawidłowa waga paczki do wysłania przez paczkomat InPost

ERR_PALLET_HEIGHT_NOT_SET Nie podano wartości w polu wysokość palety

ERR_PALLET_HEIGHT_WRONG Podana wysokość palety przekracza dostępny limit dla operatora

ERR_PALLET_MIX W jednym zleceniu nie można nadać jednocześnie paczek i palety

ERR_PALLET_QUANTITY Podana ilość palet jest nieprawidłowa

46

ERR_PALLET_UNAVAILABLE Usługa wysyłki na palecie jest niedostępna

ERR_PALLET_WEIGHT_NOT_SET Nie podano wartości w polu waga palety

ERR_PREPAID Tylko użytkownicy typu POSTPAID mogą przekazywać zlecenia do nadania

ERR_PROTOCOL_EMPTY_ARRAY Przesłana tablica numerów protokołów odbioru jest pusta

ERR_PROTOCOL_INPOST Nie można wygenerować protokołu dla zlecenia InPost

ERR_PROTOCOL_NUMBER Nieprawidłowy numer protokołu

ERR_PW_SESSION Nieprawidłowe id sesji. Zaloguj się ponownie

ERR_READ_LP_PDF_FILE Wystąpił błąd podczas odczytu pliku

ERR_REQ_VARS Brak wymaganych parametrów

ERR_RETURN_ORDER_NR_EMPTY_ARRAY Przetworzona tablica numerów zleceń jest pusta

ERR_SERVICE_UNAVAILABLE Wybrana usługa jest niedostępna

ERR_SET_ORDER_STATUS Zmiana statusu zlecenia nie powiodła się

ERR_TMP_DPD_OFF Usługi międzynarodowe operatora DPD są tymczasowo niedostępne

ERR_TMP_UPS_OFF Usługi międzynarodowe operatora UPS są tymczasowo niedostępne

ERR_USER_ADDRESS_EXIST Podany adres nie istnieje

ERR_USER_DELETE_ADDRESS Podczas usuwania adresu wystąpił błąd

ERR_USER_DELETE_ADDRESS_EXIST Podany adres nie istnieje

ERR_USER_DELETE_ADDRESS_LAST Nie można usunąć głównego adresu

ERR_USER_DELETE_ADDRESS_NOT_ARRAY Lista adresów do usunięcia powinna być typu tablicowego

ERR_USER_DELETE_ADDRESSES_LIST Przekazane adresy do usunięcia są nieprawidłowe

ERR_USER_IS_BLOCKED Dostęp użytkownika do serwisu jest zablokowany

ERR_USER_NOT_FOUND Nie znaleziono użytkownika

ERR_USER_NOT_LOGGED Wystąpił błąd! Użytkownik nie jest zalogowany

ERR_USER_ORIGIN Niepoprawne IP wywołania

ERR_USER_STATUTE_AGREE Użytkownik nie zaakceptował regulaminu.

47

ERR_VARS Nieprawidłowe parametry

ERR_WEBAPI_NOT_AVAIL W chwili obecnej dostęp do API jest wyłączony. Prosimy spróbować później

ERR_WRONG_COD_VALUE Niepoprawna wartość kwoty pobrania

ERR_WRONG_INS_VALUE Niepoprawna wartość kwoty ubezpieczenia

ERR_WRONG_ORDER_ID Błędny numer zlecenia

ERR_WRONG_ORDER_STATUS Błędny status zlecenia przekazanego do realizacji

ERR_WRONG_STATUS_NR Nieprawidłowa wartość dla statusu zlecenia

ERR_ZIP Kod pocztowy jest nieprawidłowy

ERR_ZIP_1 Kod nadawcy jest nieprawidłowy

ERR_ZIP_2 Kod odbiorcy jest nieprawidłowy

ERR_ZIP_DPD1 Kod nadawcy jest nieprawidłowy lub nieobsługiwany przez operatora DPD

ERR_ZIP_DPD2 Kod odbiorcy jest nieprawidłowy lub nieobsługiwany przez operatora DPD

ERR_ZIP_UPS1 Kod nadawcy jest nieprawidłowy lub nieobsługiwany przez operatora UPS

ERR_ZIP_UPS2 Kod odbiorcy jest nieprawidłowy lub nieobsługiwany przez operatora UPS

ERROR_DPD_WEBSERVICE 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 Opis

t_normal Standardowo

t_morning Na rano

t_tillnoon Do południa

t_saturday W sobotę

48

KODY USŁUG

SenditAPI używa następujących kodów określających usługi:

KODY USŁUG

Kod usługi Opis

COD Pobranie

INS Dodatkowe ubezpieczenie

ROD Zwrot dokumentów

SRE Odbiór własny

SSE Nadanie własne

BYH Doręczenie do rąk własnych

H24 Dostawa w 24 godziny

NST Przesyłka niestandardowa

PRV 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 Opis

alert_email Powiadomienie email

alert_sms Powiadomienie SMS

fuel_charge Opłata paliwowa

kPal Paleta

kPK Przesyłka kopertowa

kP5 Przesyłka do 5kg




49



nstd Element niestandardowy

packA Rozmiar A (8 x 38 x 64 cm)

packB Rozmiar B (19 x 38 x 64 cm)

packC Rozmiar C (41 x 38 x 64 cm)

t_afternoon_kPK Dostawa po południu – kopertowa

t_afternoon_kP5 Dostawa po południu – do 5kg






t_morning_kPK Dostawa na rano – kopertowa

t_morning_kP5 Dostawa na rano – do 5kg






t_normal_kPK Przesyłka kopertowa

t_normal_kP5 Przesyłka do 5kg






t_tillnoon_kPK Dostawa do południa – kopertowa

50

t_tillnoon_kP5 Dostawa do południa – do 5kg






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

51

15 przesyłka wydana kurierowi przesyłka w drodze

16 przesyłka gotowa do odbioru własnego w terminalu

oczekuje na odbiór

17 przesyłka awizowana - kurier nie zastał adresata

ponowne awizo

18 dokument zwrotny wysłany dokument zwrotny wysłany

19 przesyłka doręczona przesyłka odebrana

20 zwrot przesyłki do nadawcy zwrot przesyłki do nadawcy

21 wstrzymanie doręczenia - adresat nie uiścił opłat

doręczenie wstrzymane - adresat nie uiścił opłat

22 adresat odmówił przyjęcia przesyłki adresat odmówił przyjęcia przesyłki

23 adresat nieznany adresat nieznany

24 doręczenie wstrzymane - przesyłka niekompletna

doręczenie wstrzymane - przesyłka niekompletna

25 błędne dane odbiorcy - odesłanie do nadawcy

błędne dane odbiorcy - odesłanie do nadawcy

30 przesyłka niedoręczona przesyłka niedoręczona

31 przesunięty termin odbioru przesunięty termin odbioru

50 doręczenie wstrzymane doręczenie wstrzymane

60 za niska wpłata za niska wpłata

61 niedopłata niedopłata

80 zamówienie zapisane zamówienie zapisane

81 realizowanie płatności realizowanie płatności

83 płatność potwierdzona - oczekuje płatność potwierdzona - oczekuje

86 samodzielne dostarczenie - oczekuje samodzielne dostarczenie - oczekuje

90 oczekiwanie na zwrot pobrania oczekiwanie na zwrot pobrania

91 zwrot pobrania zrealizowany zwrot pobrania zrealizowany

100 zlecenie wykonane zlecenie wykonane

101 zlecenie wstrzymane zlecenie wstrzymane

110 zlecenie anulowane - odrzucone przez PayU

zlecenie anulowane - odrzucone przez PayU

52

111 zlecenie anulowane, błędne/brakujące parametry PayU

zlecenie anulowane, błędne/brakujące parametry PayU

112 zlecenie anulowane, błędne/brakujące pola formularza PayU

zlecenie anulowane, błędne/brakujące pola formularza PayU

113 zlecenie anulowane, chwilowy błąd PayU zlecenie anulowane, chwilowy błąd PayU

114 zlecenie anulowane, błąd transakcji zlecenie anulowane, błąd transakcji

115 zlecenie anulowane, błąd podczas zwrotu środków do klientowi

zlecenie anulowane, błąd podczas zwrotu środków do klientowi

116 zlecenie anulowane, błędny stan transakcji

zlecenie anulowane, błędny stan transakcji

117 zlecenie anulowane, inny błąd krytyczny - prosimy o kontakt

zlecenie anulowane, inny błąd krytyczny - prosimy o kontakt

120 zlecenie anulowane przez użytkownika zlecenie anulowane przez użytkownika

121 zlecenie anulowane automatycznie po 7 dniach

zlecenie anulowane automatycznie po 7 dniach

127 zlecenie usunięte zlecenie usunięte

128 zamówienie odrzucone zamówienie odrzucone

150 etykieta przeterminowana etykieta przeterminowana

151 nieodebrana w terminie nieodebrana w terminie

152 przekazana do oddziału przekazana do oddziału

153 przyjęto zgłoszenie reklamacyjne przyjęto zgłoszenie reklamacyjne

154 rozpatrzono reklamację rozpatrzono reklamację

200 płatność za zlecenie anulowana przez klienta

płatność za zlecenie anulowana przez klienta

201 zlecenie gotowe do ponownego nadania zlecenie gotowe do ponownego nadania

888 błędny status błędny status

dokumentacja api - sendit.pl · senditapi oferuje usługi wszystkich operatorów dostępnych w...

Documents