Dokumentacja API Stacja z Paczką ver. 2.14

Transkrypt

1 Dokumentacja API Stacja z Paczką ver. 2.14

2 2 Dokumentacja API Stacja z Paczką ver Spis treści 1 Historia zmian w dokumentacji Dostęp do API Adres URL do Web Services (SOAP/WSDL) Środowisko produkcyjne Dostępne metody Metoda getpointslist Metoda getpointsdetail Metoda getpointsprovinces Metoda getpointsdistricts Metoda getdistrictpointslist Metoda getcities Metoda getpointscity Metoda getshipments Metoda shipment Metoda updateshipment Metoda cancelshipment Opis struktur wykorzystanych w API Struktura: tns:token Struktura: tns: PointListResponse Struktura: tns: Point Struktura: tns:province Struktura: tns: District Struktura: tns: ShipmentsList Struktura: tns:package Struktura: tns:shipment Struktura:tns:ShipTo Struktura:tns:ShipFrom Struktura:tns:ShipmentResponse Struktura:tns: UpdateShipment Struktura: tns:errordetail Kody błędów Inne Lista Kurierów Dodatkowe informacje i kontakt... 15

3 3 Dokumentacja API Stacja z Paczką ver Historia zmian w dokumentacji Wersja Data Opis zmiany Nowe metody getpointsdetail, getpointsprovinces, 2.01 getpointsdistricts, getpointsdistricts Nowe metody getcities, getpointscity Nowa cancelshipment Nowa getshipmentslist Nowa updateshipment Nowe pole w strukturze tns: Point - Availability Nowe pola w strukturze tns:shipment ServiceType, CourierId, CurierPackageNumber, Description, PackageWeight Nowe pola w strukturze tns: Point Longitude, Latitude Nowe pola w strukturze tns:shipment Reference1, Reference2 Nowe pola w strukturze tns:updateshipment - Reference1, Reference Nowe pole w strukturze tns: Point - PointTypeId Nowe pola w strukturze tns: Point: openhoursmostart, openhoursmoend, openhourstustart, openhourstuend, openhourswestart, openhoursweend, openhoursthstart, openhoursthend, openhoursfrstart, openhoursfrend, openhourssastart, openhourssaend, openhourssustart, openhourssuend Nowa : shopupdate Nowy adres API 2 Dostęp do API Adres URL do Web Services (SOAP/WSDL) 2.1 Środowisko produkcyjne Produkcyjny Web Service SOAP jest dostępny pod adresem : api.stacjazpaczka.pl /WebService.asmx?ws=1 WSDL dostępny jest pod adresem: api.stacjazpaczka.pl /WebService.asmx?WSDL

4 4 Dokumentacja API Stacja z Paczką ver Dostępne metody 3.1 Metoda getpointslist Metoda weryfikuje przysłany hash będący identyfikatorem aktualnej listy punktów odbioru. Jeżeli przesyłany hash nie jest zgodny z hashem w bazie zwraca aktualną listę punktów (za pierwszym razem należy przesłać dowolny ciąg znaków). W przeciwnym wypadku zwraca tylko hash i datę aktualizacji. u getpointslist hash xsd:string Identyfikator listy punktów odbioru znajdującej się w sekcji Point Typ tns:pointlistresponse Tablica obiektów PointListResponse struktury obiektu w rozdziale 4.2 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda getpointsdetail Metoda służy do pobierania szczegółowych informacji o punktach odbioru u getpointsdetail Id xsd:integer Id punktu odbioru tns: PointListResponse Tablica obiektów PointListResponse struktury obiektu w rozdziale 4.2 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale 4.13

5 5 Dokumentacja API Stacja z Paczką ver Metoda getpointsprovinces Metoda służy do pobierania listy województw u getpointsprovinces brak brak brak tns:province Tablica obiektów Province struktury obiektu w rozdziale 4.4 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda getpointsdistricts Metoda służy do pobierania listy powiatów w województwie u getpointsdistricts ProvinceId xsd:integer Id województwa tns: District Tablica obiektów District struktury obiektu w rozdziale 4.5 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda getdistrictpointslist Metoda zwraca listę punktów dostępnych w powiecie u getdistrictpointslist DistrictId xsd:integer Id powiatu

6 6 Dokumentacja API Stacja z Paczką ver tns:pointlistresponse Tablica obiektów PointListResponse struktury obiektu w rozdziale 4.2 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda getcities Metoda służy do odpytywania o miasta w danym województwie, w których są punkty odbioru. u getcities Province xsd:string Nazwa województwa tns:string Opis Tablica miast w województwie Opis tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda getpointscity Metoda zwraca listę punktów odbioru w danym mieście, o które odpytujemy. u getpointscity City xsd:string Nazwa miasta tns:pointlistresponse Tablica obiektów PointListResponse struktury obiektu w rozdziale 4.2 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale 4.13

7 7 Dokumentacja API Stacja z Paczką ver Metoda getshipments Metoda getshipments służy do pobierania listy przesyłek konkretnego użytkownika. Parametry listy ywane za pomocą tabeli ShipmentsList. u getshipmnets Token Tns:Token Obiekt zawierający dane dostępowe 4.1 Tabela służąca do customizacji listy przesyłek ShipmentsList tns:shipmentslist obiekt any w rozdziałach 4.6 tns:package Tablica obiektów Package struktury obiektu w rozdziale 4.7 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda shipment Metoda shipment tworzy i zwraca list przewozowy paczki zawierający numer paczki, numer Dazumi i opcjonalnie numer przesyłki kuriera(dla u usługi ServiceType = 1 przesyłki z wykorzystaniem kuriera Dazumi). shipment u Token Tns:Token Obiekt zawierający dane dostępowe 4.1 Obiekt zawierający dane przesyłki obiekt Shipment tns:shipment any w rozdziałach 4.8 tns: ShipmentResponse Tablica obiektów ShipmentResponse struktury obiektu w rozdziale 4.11 tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda updateshipment Metoda updateshipment służy do aktualizowania informacji o przesyłkach. u

8 8 Dokumentacja API Stacja z Paczką ver shipment Token UpdateShipment Tns:Token tns: UpdateShipment Obiekt zawierający dane dostępowe 4.1 Obiekt zawierający dane aktualizowanej przesyłki obiekt any w rozdziałach 4.12 xsd:string Poprawna aktualizacja zwraca OK tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Metoda cancelshipment Metoda służy do anulowana przesyłek cancelsipment Token PackageNumber u Tns:Token xsd:string Obiekt zawierający dane dane dostępowe 4.1 Numer przesyłki, którą chcemy anulować. xsd:string W polu zwracany potwierdzenie, że przesyłka została anulowana tns:errordetail Tablica obiektów ErrorDetail struktury obiektu w rozdziale Opis struktur wykorzystanych w API 4.1 Struktura: tns:token pole Username xsd:string Login partnera Password xsd:string Hasło partnera

9 9 Dokumentacja API Stacja z Paczką ver Struktura: tns: PointListResponse Hash pole Identyfikator listy punktów odbioru xsd:string znajdującej się w sekcji Point Date xsd:date Data aktualizacji punktów odbioru Point tns:point Tablica obiektów point struktury obiektu w rozdziale Struktura: tns: Point pole Identyfikator punktu odbioru musi być Id xsd:integer przekazany przy wysyłaniu paczki PostalCode xsd:string Kod pocztowy punktu postaci XX-XXX City xsd:string Miasto punktu AddressLine xsd:string Ulica i numer domu punktu Name xsd:string Nazwa punktu Province xsd:string Województwo punktu ProvinceId xsd:integer Id województwa punktu District xsd:string Powiat punktu DistrictId xsd:integer Id powiatu punktu Ilość paczek, które można przesłać na Availability xsd:integer stację Longitude xsd:string Długość geograficzna Punktu Latitude xsd:string Szerokość geograficzna Punktu Typ Punktu Odbioru 1- Stacja Paliw Orlen PointTypeId xsd:integer 2- Stacja Paliw Bliska openhoursmostart xsd:string Godzina otwarcia punktu poniedziałek Godzina zamknięcia punktu openhoursmoend xsd:string poniedziałek openhourstustart xsd:string Godzina otwarcia punktu wtorek openhourstuend xsd:string Godzina zamknięcia punktu wtorek openhourswestart xsd:string Godzina otwarcia punktu środa openhoursweend xsd:string Godzina zamknięcia punktu środa openhoursthstart xsd:string Godzina otwarcia punktu czwartek openhoursthend xsd:string Godzina zamknięcia punktu czwartek openhoursfrstart xsd:string Godzina otwarcia punktu piątek openhoursfrend xsd:string Godzina zamknięcia punktu piątek openhourssastart xsd:string Godzina otwarcia punktu sobota openhourssaend xsd:string Godzina zamknięcia punktu sobota Godzina otwarcia punktu niedziela openhourssustart xsd:string Godzina zamknięcia punktu niedziela openhourssuend xsd:string

10 10 Dokumentacja API Stacja z Paczką ver Struktura: tns:province pole Id xsd:integer Id województwa Province xsd:string Województwo 4.5 Struktura: tns: District pole Id xsd:integer Id powiatu District xsd:string Powiat 4.6 Struktura: tns: ShipmentsList pole Login xsd:string Login użytkownika Offset xsd:integer Numer wiersza zaczynającego listę RowCount xsd:integer Ilość wierszy na stronie PackageNumber xsd:string Numer przesyłki w Stoppoint CurierPackageNumber xsd:string Numer listu przewozowego u kuriera Data wysłania - początek zakresu DispatchDateStart xsd:date szukania Data wysłania - koniec zakresu DispatchDateEnd xsd:date szukania Data dostawy - początek zakresu DeliveryDateStart xsd:date szukania Data dostawy - koniec zakresu DeliveryDateEnd xsd:date szukania RecipientName xsd:string Nazwa Odbiorcy SenderName xsd:string Nazwa Nadawcy PackStatusCode xsd:integer Kod statusu paczki w stoppoint CODStatusCode xsd:integer Kod statusu pobrania paczki InvoiceStatus xsd:integer Status Faktury VAT InvoiceNumber xsd:string Numer Faktury VAT

11 11 Dokumentacja API Stacja z Paczką ver Struktura: tns:package pole PackageNumber xsd:string Numer Przesyłki Stoppoint CurierPackageNumber xsd:string Numer listu przewozowego u kuriera RecipientName xsd:string Nazwa Odbiorcy SenderName xsd:string Nazwa Nadawcy PackStatusCod xsd:integer Kod statusu paczki w stoppoint PackStatusDescription xsd:string Nazwa statusu przesyłki DispatchDate xsd:date Data wysłania DeliveryDate xsd:date Data dostawy CODAmount xsd:integer Kwota pobrania Obiekt point struktury obiektu w Point tns:point rozdziale 4.3 Zakodowany encode64 plik listu Label xsd:string przewozowego CODStatusCode xsd:integer Kod statusu pobrania CODStatusDecription xsd:string Nazwa statusu pobrania DazumiNumber xsd:string Kod Dazumi 4.8 Struktura: tns:shipment pole Obiekt zawierające dane odbiorcy ShipTo tns:shipto obiektu w rozdziale 4.9 Obiekt zawierający dane miejsca tns:shipfro odbioru przesyłki przez kuriera, ShipFrom m obiektu w rozdziale 4.10 Format listu przewozowego możliwe LabeliImageFormat xsd:string formaty gif, pdf Flaga określająca czy przesyłka jest pobraniowa czy nie możliwe wartości 0 nie pobraniowa 1- pobraniowa CODAmountFLAG CODAmount PaymentFlag xsd:integer xsd:integer xsd:integer UWAGA! Przy ie usługi ServiceType = 2 zamawiając kuriera samemu nie należy dodatkowo zaznaczać u własnego kuriera opcji Pobranie. Wszelkie operacje pobraniowe rozlicza Dazumi. Kwota pobrania w groszach dla przesyłek nie pobraniowych 0 Flaga określająca czy przesyłka opłacona czy nie, możliwe wartości

12 12 Dokumentacja API Stacja z Paczką ver postpaid 1 prepaid PickupDate SelfDeliverToSorting ServiceType xsd:date xsd:integer xsd:integer UWAGA! Metoda płatności jest określona w ustawieniach sklepu. Sugerowana data odbioru przesyłki z magazynu przez kuriera Flaga określająca czy przesyłka dostarczona do sortowni samodzielnie, możliwe wartości 0 kurier przyjeżdża po przesyłkę 1 samodzielne dostarczenie do sortowni Typ usługi: 1 wykorzystanie kuriera Stoppoint 2 wykorzystanie własnego kuriera Przy ServiceType = 2 nie jest generowany pełen list przewozowy kuriera CourierId xsd:integer ID kuriera lista kurierów w rozdziale 6.1 Numer listu przewozowego u CurierPackageNumber xsd:string wybranego kuriera Opis przesyłki, który drukowany będzie Description xsd:string na etykiecie. Maksymalnie 256 znaków. PackageWeight xsd:integer Waga paczki w kilogramach Reference1 xsd:string Numer referencyjny 1 Reference2 xsd:string Numer referencyjny Struktura:tns:ShipTo pole FirstName xsd:string Imię odbiorcy LastName xsd:string Nazwisko odbiorcy Numer telefonu odbiorcy paczki (jeśli PhoneNumber xsd:string brak to 0) PointId xsd:integer Identyfikator punktu odbioru 4.10 Struktura:tns:ShipFrom pole Name xsd:string Nazwa firmy nadawcy AttentionName xsd:string Nazwisko osoby kontaktowej nadawcy AddressLine xsd:string ulica miejsca nadania przesyłki City xsd:string miasto nadania przesyłki

13 13 Dokumentacja API Stacja z Paczką ver PostalCode xsd:string kod pocztowy nadania przesyłki CountryCode xsd:string kod Państwa nadania przesyłki PhoneNumber xsd:string telefon miejsca nadania przesyłki Login xsd:string Login w systemie Stoppoint 4.11 Struktura:tns:ShipmentResponse pole Opis PackageNumber xsd:string Numer Stoppoint CurierPackageNumber xsd:string DazumiNumber xsd:string Numer listu przewozowego Kod Dazumi UWAGA! Przy ie usługi ServiceType =2 numer Dazumi należy umieścić na liście zakodowane Code128 LabeLimageFormat xsd:string Format pliki z listem przewozowym Label xsd:string Zakodowany encode64 plik listu przewozowego Obiekt punkt na który została wysłana paczka Point tns:point obiektu w rozdziale 4.3 Date xsd:date Data utworzenia wysyłki Możliwa liczba dni opóźnienia paczki (w związku z Delay xsd:int obłożeniem punktu) 4.12 Struktura:tns: UpdateShipment pole Opis PackageNumber xsd:string Numer Stoppoint CurierPackageNumber xsd:string Numer listu przewozowego Kod Dazumi UWAGA! Przy ie usługi ServiceType =2 numer Dazumi należy umieścić na DazumiNumber xsd:string liście zakodowane Code128 Status listu przewozowego u kuriera 1- Utworzona etykieta 2- Paczka w drodze PackStatusCode xsd:integer 3- Paczka na stacji ID kuriera lista kurierów w rozdziale CourierId xsd:integer 6.1 Reference1 xsd:string Numer referencyjny 1 Reference2 xsd:string Numer Reerencyjny Struktura: tns:errordetail pole Area xsd:string Obszar występowania błędu Code xsd:string Kod błędów Description xsd:string Opis błędu

14 14 Dokumentacja API Stacja z Paczką ver Kody błędów obszar występowania błędu Account Points Clients ShipTo ShipFrom Package kod błędu błędu Wprowadzone hasło jest nieprawidłowe lub konto o podanym 1001 loginie nie istnieje 1002 Błędna konfiguracja Partnera 1003 Błąd po stronie Partnera 1004 Błędny numer klienta u kuriera 1011 Brak uprawnień 2001 Punkt o podanym ID nie istnieje 2002 Błędne ID województwa 2003 Błędne ID powiatu 2004 Błędna nazwa województwa 2005 Błędna nazwa województwa 2006 Błędna nazwa miasta 2007 Brak punktów w województwie 3001 Błędny login klienta 3002 Błędna wartość doładowania 3003 Błędna wartość pola TransferTitle 3004 Brak środków na koncie 3005 Przekroczony limit 4001 Błędna wartość pola FirstName 4002 Błędna wartość pola LastName 4003 Błędna wartośc pola PhoneNumber 4004 Błędna wartość pola PointID 4005 Błędny numer paczki 4006 Paczka nie może zostać anulowana 4007 Odmowa kuriera 5001 Błędna wartość pola Name 5002 Błędna wartość pola AttentionName 5004 Błędna wartość pola AddressLine 5005 Błędna wartość pola City 5006 Błędna wartość pola PostalCode 5007 Błędna wartość pola CountryCode 5008 Błędna wartość pola PhoneNumber 5009 Błędna wartość pola Login 6001 Błędna wartość kwoty pobrania Błędna wartość flagi czy paczka pobraniowa (możliwe 6002 wartości 0 1 ) 6003 Błędna wartość kwoty przesyłki 6004 Błędna wartość VAT Błędna wartość flagi czy przesyłka opłacona (możliwe wartości ) 6006 Błędna wartość atrybutu flaga dazumi 6007 Błędna wartość pola ServiceType 6008 Błędna wartość pola CourierId 6009 Błędna wartość pola CurierPackageNumber

15 15 Dokumentacja API Stacja z Paczką ver Błędna wartość pola Description 6011 Błędna wartość pola PackageWeight Nieobsługiwany format listu przewozowego - możliwy format to Lebel 7001 GIF i PDF 7002 Problem u kuriera 6 Inne 6.1 Lista Kurierów Nazwa Kuriera ID Kuriera UPS 1 7 Dodatkowe informacje i kontakt Odpowiedzi na wszelkie pytania oraz dodatkowe informacje uzyskać można kontaktując się z nami: Wsparcie techniczne- Dział IT it@stacjazpaczka.pl Dazumi Sp. z o. o Ul. Mickiewicza Warszawa tel/faks: biuro@dazumi.com.pl