Dokumentacja
API

1. Historia zmian w dokumentacji

Wersja Data Opis zmiany
1.00 30-03-2018 Utworzenie dokumentacji

2. Dostęp do API – Adres URL do Web Services (SOAP/WSDL)

2.1. Środowisko testowe

Testowy Web Service SOAP jest dostępny pod adresem:

https://devapi.shippingmanager.pl/api.asmx

WSDL dostępny jest pod adresem:

https://devapi.shippingmanager.pl/api.asmx?wsdl

2.2. Środowisko produkcyjne

Produkcyjny Web Service SOAP jest dostępny pod adresem:

https://api.shippingmanager.pl/api.asmx

WSDL dostępny jest pod adresem:

https://api.shippingmanager.pl/api.asmx?wsdl

3. Dostępne metody

3.1 Metoda GetAvailableServices

Metoda służy do pobrania listy dostępnych serwisów oraz ewentualnie ich wycenę

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
getAvailableServicesRequest tns:GetAvailableServicesRequest Obiekt zawierający dane przesyłki

 

Wynik:

typ opis
GetAvailableServicesResponse Obiekt zawierający informację o dostępnych usługach

3.2. Metoda CreateShipment

Metoda służy do utworzenia nowej przesyłki

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
shipmentRequest tns:ShipmentRequest Obiekt zawierający dane przesyłki

 

 

Wynik:

typ opis
tns:CreateShipmentResponse Tablica obiektów CreateShipmentResponse

3.3. Metoda CancelShipment

Metoda służy do anulowania zlecenia

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
cancelShipmentRequest Tns:CancelShipmentRequest Obiekt zawierający tablice numerów przesyłek

 

Wynik:

typ opis
tns:CancelShipmentResponse Tablica obiektów CancelShipmentResponse

3.4. Metoda GetLabel

Metoda służy do pobrania wcześniej wygenerowanej etykiety

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
request tns:request Obiekt zawierający tablice numerów przesyłek

 

Wynik:

typ opis
tns:GetLabelResponse Tablica obiektów GetLabelResponse

3.5. Metoda GetManifest

Metoda służy do pobrania manifestu nadania przesyłek

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
getManifestRequest tns:GetManifestRequest Obiekt zawierający tablice numerów przesyłek dla których wygenerowany ma zostać manifest

 

Wynik:

typ opis
tns:GetManifestResponse Tablica obiektów GetManifestResponse

3.6. Metoda CallPickup

Metoda służy do zamawiania podjazdu kuriera

parametr typ parametru opis
AuthToken tns:AuthToken Obiekt zawierający dane dostępowe
callPickupRequest tns:CallPickupRequest Obiekt zawierający dane o zamawianym podjeździe kuriera

 

Wynik:

typ opis
tns:CallPickupResponse Tablica obiektów CallPickupResponse

3.7. Metoda GetTracking

Metoda służy do pobrania statusu przesyłki

parametr typ parametru opis
AuthToken tns:AuthToken Obiekt zawierający dane dostępowe
PackageNo s:string Numer paczki

 

Wynik:

typ opis
tns:GetTrackingResponse Tablica obiektów Tracking

3.8. Metoda GetServicesInfo

Metoda służy do pobrania informacji o dostępnych serwisach

parametr typ parametru opis
AuthToken tns:AuthToken Obiekt zawierający dane dostępowe

 

Wynik:

typ opis
tns:GetServicesInfoResponse Obiektów zawierający tablice obiektów typu tns:GetServicesInfoResponse

3.9. Metoda CancelPickup

Metoda służy do anulowania podjazdu

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
CancelPickupRequest tns:CancelPickupRequest Obiekt zawierający dane dotyczące podjazdów do anulowania

Wynik:

typ opis
tns:GetServicesResponse Obiekt zawierający dane dotyczące obsługiwanych przez API serwisów

3.10. Metoda GetPointsList

Metoda służy do pobrania informacji o dostępnych punktach odbioru przesyłki

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
getPointsListRequest tns:GetPointsListRequest Obiekt zawierający dane na temat parametrów do filtrowania

Wynik:

typ opis
tns:GetPointsListResponse Obiekt zawierający tablicę obiektów tns:Point

3.11. Metoda GetPoint

Metoda służy do pobrania informacji o punkcie odbioru przesyłki

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
getPointRequest tns:GetPointRequest Obiekt zawierający identyfikator punktu odbioru przesyłki

Wynik:

typ opis
tns:GetPointResponse Obiekt zawierający tns:Point

3.12. Metoda EnqueueReport

Metoda służy do dodania raportu do kolejki

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
enqueueReportRequest tns:EnqueueReportRequest Obiekt zawierający dane służące do wygenerowania określonego typu raportu

Wynik:

typ opis
tns:EnqueueReportResponse Obiekt zawierający GUID dodanego do kolejki raportu

3.13. Metoda CheckReportQueueStatus

Metoda służy do dodania raportu do kolejki

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
checkReportQueueStatusRequest tns:CheckReportQueueStatusRequest Obiekt zawierający GUID raportu

Wynik:

typ opis
tns:CheckReportQueueStatusResponse Obiekt zawierający tns:ReportQueueStatus

3.14. Metoda DownloadReport

Metoda służy do pobierania raportu

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
downloadReportRequest tns:DownloadReportRequest Obiekt zawierający GUID raportu

Wynik:

typ opis
tns:DownloadReportResponse Obiekt zawierający wygenerowany plik raportu

3.15. Metoda GetCarrier

Metoda służy do pobrania przewoźników i ich Id(Nie oznacza to że wszyscy wylistowani są dostępni dla klienta!)

parametr typ parametru opis
token tns:AuthToken Obiekt zawierający dane dostępowe
GetCarrierReques tns:GetCarrierRequest Pusty Obiekt

Wynik:

typ opis
tns:GetCarrierResponse Tablica obiektów GetCarrierResponse

4. Opis struktur wykorzystanych w API

4.1. Struktura: tns: AuthToken

pole typ opis Czy pole obowiązkowe
UserName xsd:string Login partnera TAK
Password xsd:string Hasło partnera TAK

4.2. Struktura: tns: ShipmentRequest

pole typ opis czy pole obowiązkowe
ServiceId xsd:string ID  wybranego serwisu – usługi podstawowej. Sprawdź rozdział Słowniki. TAK
ShipFrom tns:Location Obiekt typu Location zawierający dane nadawcy TAK
ShipTo tns:Location Obiekt typu Location zawierający dane odbiorcy TAK
Parcels tns:Parcel[] Tablica obiektu Parcel TAK
COD tns:COD Obiekt typu COD zawierający informacje o pobraniu TAK
InsuranceAmount xsd:decimal Wartość ubezpieczenia w złotówkach

Domyślnie: 0

TAK
AdditionalServices tns:AdditionalService[] Usługi dodatkowe: Tablica obiektów AdditionalService. Sprawdź rozdział Słowniki. NIE
LabelFormat tns:LabelImageFormat Format etykiety – może przyjąć następujące wartości: Nonem PDF, PDFA4, GIF, Domyślnie: PDF TAK
LoyaltyCardNo xsd:string Numer karty (program lojalnościowy) NIE
RebateCoupon xsd:string Kod kuponu rabatowego NIE
ContentDescription xsd:string Opis zawartości TAK
MPK xsd:string MPK NIE
ReferenceNumber xsd:string Numer referencyjny NIE

4.3. Struktura: tns: CreateShipmentResponse

pole typ opis
PackageNo xsd:string Główny numer przesyłki
ParcelData tns: Label[] Tablica obiektów Label
responseCode Xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.4. Struktura: tns: GetAvailableServicesRequest

pole typ opis czy pole obowiązkowe
ReadyDate xsd:dateTime Data gotowości podjęcia przesyłki przez kuriera TAK
ShipFrom tns:Location Obiekt typu Location zawierający dane nadawcy TAK
ShipTo tns:Location Obiekt typu Location zawierający dane odbiorcy TAK
Parcels tns:Parcel[] Tablica obiektu Parcel TAK
COD tns:COD Obiekt typu COD zawierający informacje o pobraniu TAK
InsuranceAmount xsd:decimal Wartość ubezpieczenia w złotówkach TAK
AdditionalServices tns:AdditionalService[] Usługi dodatkowe: Tablica obiektów AdditionalService. Sprawdź rozdział Słowniki. NIE

4.5. Struktura: tns: Location

pole typ opis czy pole obowiązkowe
PointId xsd:string ID punktu odbioru NIE
PointType xsd:string ID Asapon punkt lub paczkomat NIE
Name xsd:string Nazwa TAK
Address xsd:string Adres TAK
City xsd:string Miasto TAK
PostCode xsd:string Kod pocztowy TAK
CountryCode xsd:string Kod kraju, zgodny z normą ISO 3166-2 TAK
Person xsd:string Imię i nazwisko TAK
Contact xsd:string Telefon TAK
Email xsd:string Adres email TAK
IsPrivatePerson xsd:boolean Adres prywatny TAK

4.6. Struktura: tns: Parcel

pole typ opis czy pole obowiązkowe
Type tns:ParcelType Rodzaj opakowania. Możliwe wartości:    koperta (Envelope), paczka (Package), paleta (Palette), przesyłka paczkomatowa rozmiar A (ParcelLockerA), przesyłka paczkomatowa rozmiar B (ParcelLockerB), przesyłka paczkomatowa rozmiar C (ParcelLockerC) TAK
Weight xsd:decimal Waga przesyłki [kg] TAK
D xsd:decimal Długość przesyłki [cm] NIE
W xsd:decimal Wysokość przesyłki [cm] NIE
S xsd:decimal Szerokość przesyłki [cm] NIE
IsNST xsd:boolean Czy wymiary niestandardowe? NIE

4.7. Struktura: tns: COD

pole typ opis czy pole obowiązkowe
Amount xsd:decimal Kwota pobrania w złotówkach TAK
RetAccountNo xsd:string Numer konta na które powinny zostać zwrócone pieniądze NIE
Currency xsd:decimal Waluta, możliwa wartość: PLN TAK

4.8. Struktura: tns: AdditionalService

pole typ opis czy pole obowiązkowe
Code xsd:string ID usługi dodatkowej. Sprawdź rozdział Słowniki. TAK

4.9. Struktura: tns: Service

pole typ opis
ID xsd:int ID dostępnego serwisu. Sprawdź rozdział Słowniki
Name xsd:string Nazwa dostępnego serwisu

4.10. Struktura: tns: Label

pole typ opis
ParcelID xsd:string Numer paczki
MimeFormat tns:LabelImageFormat Format etykiety – może przyjąć następujące wartości: None, GIF, PDF, PDFA4
MimeData xsd: base64Binary Etykieta

4.11. Struktura: tns: cancelShipmentRequest

pole typ opis czy pole obowiązkowe
Carrier xsd:string Nazwa przewoźnika TAK
PackageNo xsd:string[] Tablica numerów przesyłek TAK

4.12. Struktura: tns: CancelShipmentResponse

pole typ opis
responseCode xsd:int Kod zwrócony
responseDescription xsd:string Opis kodu

4.13. Struktura: tns: Request

pole typ opis czy pole obowiązkowe
RequestedLabels xsd:string Obiekt RequestedLabels TAK
MimeFormat xsd:string Format etykiety – może przyjąć następujące wartości: None, PDF, PDFA4, GIF TAK

4.14. Struktura: tns: RequestedLabels

pole typ opis czy pole obowiązkowe
PackagesByCarrier xsd:string[] Tablica obiektów PackagesByCarrier TAK

4.15. Struktura: tns: PackagesByCarrier

pole typ opis czy pole obowiązkowe
PackageNo xsd:string Numer przesyłki TAK
Carrier xsd:string Nazwa przewoźnika – może przyjąć następujące wartości: ups, dpd, inpost, inpost_parcelLockers, kaab_poland, kaab_kaabInternational TAK

4.16. Struktura: tns: GetLabelResponse

pole typ opis
ParcelID xsd:string Numer przesyłki
MimeFormat xsd:string Format etykiety – może przyjąć następujące wartości: None, PDF, PDFA4, GIF
MimeData xsd: base64Binary Etykieta
Carrier xsd:string Nazwa przewoźnika – może przyjąć następujące wartości: ups, dpd, inpost, inpost_parcelLockers, kaab_poland, kaab_kaabInternational
responseCode xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.17. Struktura: tns: GetManifestRequest

pole typ opis czy pole obowiązkowe
PackageNo xsd:string[] Tablica numerów przesyłek TAK

4.18. Struktura: tns: GetManifestResponse

pole typ opis
ManifestNo xsd:string Numer przesyłki
MimeFormat xsd:string Format manifestu
MimeData xsd: base64Binary Manifest
responseCode xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.19 Struktura: tns: CallPickupRequest

pole typ opis czy pole obowiązkowe
Carrier tns:string Nazwa przewoźnika – może przyjąć następujące wartości: ups, dpd, inpost, inpost_parcelLockers, kaab_poland, kaab_kaabInternational TAK
PickupLocation tns:Location Adres miejsca odbioru przesyłek TAK
ReadyDate xsd:dateTime Data i godzina początku gotowości paczki do pojęcia TAK
MaxPickupDate xsd:dateTime Data i godzina  końca gotowości paczki do pojęcia TAK
PackageNo xsd:string[] Tablica numerów przesyłek TAK
Parcels tns:Parcel[] Tablica obiektów typu tns:Parcel TAK
TotalQuantity xsd:string[] Całkowita ilość TAK
TotalWeight xsd:int Łączna waga wszystkich przesyłek [kg] TAK

4.20. Struktura: tns: CallPickupResponse

pole typ opis
responseCode xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.21. Struktura: tns: Tracking

pole typ Opis
Status tns:ArrayOfOrderStatus Status
DatePicked xsd:dateTime Data odebrania przesyłki od nadawcy
DateDelivered xsd:dateTime Data odebrania przesyłki na stacji
CurrentStatus tns:OrderStatus Aktualny status przesyłki
responseCode xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.22. Struktura: tns: OrderStatus

pole typ Opis
PackageNo xsd:String Numer paczki
Code xsd:string Kod statusu
Description xsd:string Opis statusu
DescriptionEN xsd: string Opis statusu w j. angielskim
EventTimestamp xsd: dateTime Data statusu
EventParam tns:string Parametr statusu (np. miasto gdzie status się wydarzył)

4.23. Struktura: tns: GetServicesInfoResponse

pole typ Opis
ID xsd:int Dzień na który możliwe jest złożenie zlecenia podjazdu
Name xsd:string Minimalna wartość na dany dzień którą można podać jako ReadyDate w strukturze tns:CallPickupRequest
AdditionalServicesInfo tns:AdditionalService[] Usługi dodatkowe: Tablica obiektów AdditionalService. Sprawdź rozdział Słowniki.
Carrier xsd:string Nazwa przewoźnika – może przyjąć następujące wartości: ups, dpd, inpost, inpost_parcelLockers, kaab_poland, kaab_kaabInternational

4.24. Struktura: tns: CancelPickupRequest

pole typ Opis
Carrier xsd:string Nazwa przewoźnika – może przyjąć następujące wartości: ups, dpd, inpost, inpost_parcelLockers, kaab_poland, kaab_kaabInternational
PickupNo xsd:string Numer pickupu

4.25. Struktura: tns: CancelPickupResponse

pole typ Opis
responseCode xsd:int Kod błędu
responseDescription xsd:string Opis błędu

4.26. Struktura: tns: Label

pole typ opis
ParcelID xsd:string Numer paczki
MimeFormat tns:LabelImageFormat Format etykiety – może przyjąć następujące wartości: GIF, EPL, PDF, PDFA4 (etykieta w formacie A4), PDF_DOUBLE (etykieta 10×15, dwie strony)
MimeData xsd:base64Binary Etykieta

4.27. Struktura: tns: GetPointsListRequest

pole typ opis
LastSynchronization xsd:dateTime Data ostatniej synchronizacji

4.28. Struktura: tns: GetPointsListResponse

pole typ opis
LastSynchronization xsd:dateTime Data bieżącej synchronizacji
Points tns:Points[] Tablica obiektów tns:Point

4.29. Struktura: tns: Point

pole typ opis
Id xsd:int Identyfikator punktu
CarrierId xsd:int Id przewoźnika (do pobrania metodą GetCarriers)
ExternalId xsd:string Zewnętrzny identyfikator punktu
PostalCode xsd:string Kod pocztowy
AddressLine xsd:string Ulica
Name xsd:string Nazwa
Province xsd:string Województwo
District xsd:string Powiat
City xsd:string Miejscowość
Longitude xsd:deciaml Długość geograficzna
Latitude xsd:deciaml Szerokość geograficzna
PointType tns:PointType Typ punktu
OpeningMoHourStart xsd:string Godzina otwarcia w poniedziałek
OpeningMoHourStop xsd:string Godzina zamknięcia w poniedziałek
OpeningTuHourStart xsd:string Godzina otwarcia we wtorek
OpeningTuHourStop xsd:string Godzina zamknięcia we wtorek
OpeningWeHourStart xsd:string Godzina otwarcia w środę
OpeningWeHourStop xsd:string Godzina zamknięcia w środę
OpeningThHourStart xsd:string Godzina otwarcia w czwartek
OpeningThHourStop xsd:string Godzina zamknięcia w czwartek
OpeningFrHourStart xsd:string Godzina otwarcia w piątek
OpeningFrHourStop xsd:string Godzina zamknięcia w piątek
OpeningSaHourStart xsd:string Godzina otwarcia w sobotę
OpeningSaHourStop xsd:string Godzina zamknięcia w sobotę
OpeningSuHourStart xsd:string Godzina otwarcia w niedzielę
OpeningSuHourStop xsd:string Godzina zamknięcia w niedzielę

4.30. Struktura: tns: PointType

Pole opis
Unknown Nieznany typ punktu odbioru
InpostPaczkomat Paczkomat InPost

4.31. Struktura: tns: GetPointRequest

pole Typ opis
PointId xsd:int Identyfikator punktu

4.32. Struktura: tns: GetPointResponse

pole Typ opis
Point tns:Point Obiekt typu tns:Point

4.33. Struktura: tns: EnqueueReportRequest

pole Typ opis
ReportType tns:ReportType Typ raportu
From xsd:dateTime Data od której ma być wygenerowany raport
To xsd:dateTime Data do której ma być wygenerowany raport

4.34. Struktura: tns: ReportType

pole opis
Unknown Niezidentyfikowany typ raportu
ExampleReport Przykładowy raport

4.35. Struktura: tns: EnqueueReportResponse

pole Typ opis
ReportGuid xsd:string Unikalny identyfikator raportu

4.36. Struktura: tns: CheckReportQueueStatusRequest

pole Typ opis
ReportGuid xsd:string Unikalny identyfikator raportu

4.37. Struktura: tns: CheckReportQueueStatusResponse

pole typ opis
QueueStatus tns:ReportQueueStatus Status raportu

4.38. Struktura: tns: ReportQueueStatus

pole opis
Unknown Nieznany status raportu
Queued Raport dodany do kolejki
Ready Raport gotowy do pobrania

4.39. Struktura: tns: DownloadReportRequest

pole typ opis
ReportGuid xsd:string Unikalny identyfikator raportu

4.40. Struktura: tns: DownloadReportResponse

pole typ opis
ReportData xsd:base64Binary Raport

Poniżej lista statusów zwracanych w strukturze TNS:ORDERSTATUS.

OrderStatus.Code OrderStatus.Description
ANU Anulowane
AOP Odbiorca odmówił przyjęcia
AWI Przesyłka awizowana
AWI II Powtórne awizo
AZPO Zwrot dokumentów
BDA Błędne dane adresowe
BRC Brak możliwości doręczenia
BRD Błędny rejon doręczenia
BRG Brak gotówki
BSO Błędny sort
DOR Doręczono
GAB Przesyłka ponadgabarytowa
INN Inny status
KTN Brak możliwości kontaktu z Odbiorcą
LIK Likwidacja przesyłki
MKK Mylny kierunek
MOD Możliwe opóźnienie doręczenia
NNI Przesyłka nieidentyfikowalna
OW Ustalony odbiór własny
PAD Przeadresowanie do innego oddziału
PDD Przekazano do doręczenia
PKL Przyjęta od klienta przez kuriera
PKM Przyjęta od kuriera przez magazyn
PNA Przekierowanie na adres wewnątrz oddziału
POS Posortowana
PPN Przygotowana przez nadawcę
PWO Przyjęta w oddziale
PWS Przyjęta w sortowni
USZ Przesyłka uszkodzona
UTD Umówiony termin doręczenia
WRW Weryfikacja wagi przesyłki
WZO Wysłana z oddziału
WZS Wysłana z sortowni
ZAG Zaginiona
ZAK Zlecenie oczekujące do realizacji
ZDM Zwrot do magazynu przesyłek niedoręczalnych
ZDN Wygenerowano etykietę zwrotną przesyłki niedoręczonej
ZOK Zlecenie odrzucone przez kuriera
ZPK Zlecenie przyjęte od klienta
ZPOW Zlecenie powielone
ZPRZEN Zlecenie przeniesione
ZWK Wydanie zlecenia na kuriera
ZWR Zwrot od kuriera na magazyn
ZZZ Zlecenie zrealizowane

5. SŁOWNIKI

5.1. Usługi podstawowe – serwisy

Nazwa przewoźnika ID przewoźnika ID usługi Nazwa Usługi
UPS Polska 39 122 UPS Express Saver
InPost Paczkomaty 46 123 InPost Paczkomaty
InPost 1 124 InPost Express Standardowy
InPost 1 125 InPost Express do 12:00
InPost 1 126 InPost Express do 17:00
Świat Przesyłek Krajowy 45 127 Świat Przesyłek Krajowa
DPD Polska 15 128 DPD Classic
UPS Polska 39 129 UPS Express Plus
InPost 1 130 InPost Express do 10:00
FedEx Poland 17 131 FedEx Standard Paczki
FedEx Poland 17 132 FedEx Standard Palety
Geis PL 49 137 Geis Standard
Poczta Polska 29 138 Polecona krajowa
Poczta Polska 29 139 Polecona krajowa priorytetowa
Poczta Polska 29 140 Polecona firmowa
Poczta Polska 29 141 Polecona firmowa priorytetowa
Poczta Polska 29 142 List zwykły ekonomiczny
Poczta Polska 29 143 List zwykły priorytetowy
Poczta Polska 29 144 List biznesowy
Poczta Polska 29 145 Paczka pocztowa
Poczta Polska 29 146 Paczka pocztowa priorytetowa
Poczta Polska 29 147 Miejski do 3h do 5km
Poczta Polska 29 148 Miejski do 3h do 10km
Poczta Polska 29 149 Miejski do 3h do 15km
Poczta Polska 29 150 Miejski do 3h powyżej 15km
Poczta Polska 29 151 Miejski do 4h do 10km
Poczta Polska 29 152 Miejski do 4h do 15km
Poczta Polska 29 153 Miejski do 4h do 20km
Poczta Polska 29 154 Miejski do 4h do 30km
Poczta Polska 29 155 Miejski do 4h do 40km
Poczta Polska 29 156 Krajowy
Poczta Polska 29 157 Bezpośredni do 20kg
Poczta Polska 29 158 Bezpośredni od 20kg do 30kg
Poczta Polska 29 159 Bezpośredni od 30kg do 100kg
Poczta Polska 29 160 Ekspres24
Poczta Polska 29 161 Przesyłka biznesowa (Pocztex48)
Świat Przesyłek – KRAJOWY INPOST 48 162 Inpost Standard (ŚP)
Świat Przesyłek – KRAJOWY INPOST 48 163 Inpost Express 12 (ŚP)
Świat Przesyłek – KRAJOWY INPOST 48 164 Inpost Express 17 (ŚP)
DHL Express Poland 14 165 Przesyłka krajowa
DHL Express Poland 14 166 Domestic 09
DHL Express Poland 14 167 Domestic 12
Poczta Polska S.A. 29 168 Palety
OlzaLogistic 53 169 GLS CZ BusinessParcel
Ruch S.A. 50 170 Paczka w Ruchu
GLS sp. z o.o 52 171 Przesyłka kurierska
GLS sp. z o.o 52 175 Pick&Ship-Service
GLS sp. z o.o 52 176 Pick&Return-Service
OlzaLogistic 53 180 GLS CZ BusinessParcel
OlzaLogistic 53 181 GLS SK BusinessParcel
OlzaLogistic 53 182 GLS PL BusinessParcel
OlzaLogistic 53 183 GLS CZ EuroBusinessParcel
OlzaLogistic 53 184 Česká pošta – Balík do ruky
OlzaLogistic 53 185 Česká pošta – Balík na poštu
OlzaLogistic 53 186 Česká pošta – Doporučené psaní
OlzaLogistic 53 187 Slovenská pošta – Expres Kuriér
OlzaLogistic 53 188 DPD PL Classic
OlzaLogistic 53 189 Geis – Paletová přeprava B2C
OlzaLogistic 53 190 PPL parcel CZ private
OlzaLogistic 53 191 Zásilkovna – Pickup point
OlzaLogistic 53 192 Zásilkovna – Hungarian Post
OlzaLogistic 53 193 Zásilkovna – FAN Romania
OlzaLogistic 53 194 Zásilkovna – SPEEDY Bulgaria
OlzaLogistic 53 195 Zásilkovna – DPD Hungary
OlzaLogistic 53 196 Zásilkovna – DPD Bulgaria
OlzaLogistic 53 197 Zásilkovna – DPD Romania
OlzaLogistic 53 198 Zásilkovna – Best delivery
OlzaLogistic 53 199  Zásilkovna – Cargus
Cargus 63 200 Economic Standard
Cargus 63 201 Easy Collect Standard
Cargus 63 202 Economic Standard Plus
Cargus 63 203 Pallet Standard
DPD Polska 15 228 DPD Pickup Point
OlzaLogistic 53 230  Zásilkovna – Austria Post
Poczta Węgierska 65 301 Buisness Parcell
Poczta Węgierska 65 302 Postal Parcell
Fan Courier 66 401 Standard
Fan Courier 66 402 RedCode
Fan Courier 66 403 Caiet Sarcini
Fan Courier 66 404 Express Loco 1H
Fan Courier 66 405 Express Loco 2H
Fan Courier 66 406 Express Loco 4H
Fan Courier 66 407 Express Loco 6H
Fan Courier 66 408 Cont Colector
Fan Courier 66 409 Express Loco 1H-Cont Colector
Fan Courier 66 410 Express Loco 2H-Cont Colector
Fan Courier 66 411 Express Loco 4H-Cont Colector
Fan Courier 66 412 Express Loco 6H-Cont Colector
Fan Courier 66 413 Red code-Cont Colector
Fan Courier 66 414 Export
Fan Courier 66 415 Export-Cont Colector
Fan Courier 66 416 Produse Albe
Fan Courier 66 417 Produse Albe-Cont Colector
Fan Courier 66 418 Transport Marfa
Fan Courier 66 419 Transport Marfa-Cont Colector
Fan Courier 66 420 Transport Marfa Produse Albe
Fan Courier 66 421 Transport Marfa Produse Albe-Cont Colector
InTime 67 501 Doručení na adresu
InTime 67 502 Doručení do výdejního místa
Meest 68 519 Доставка на адрес
Meest 68 520 Доставка до Meest Box

5.2. Usługi dodatkowe

Kod usługi dodatkowej OrderStatus.Description
ROD Dokumenty zwrotne
SOB Doręczenie w sobotę
SMSS Serwis SMS
EMAILS Serwis email
DOR1720 Doręczenie w godzinach 17:00 – 20:00
ZDOR Doręczenie w godzinach 18:00-22:00
ZASTG Doręczenie przesyłki na godzinę
CODEX COD Express
SOB Doręczenie w sobotę
NAD Nadanie z innego adresu
KSD Podjazd kuriera w kolejnych dniach
KND Podjazd kuriera w kolejnych dniach
SMSA Awizo SMS
ADRPRY Doręczenie pod adres prywatny
DOR0930 Doręczenie do 9:30
DOR1200 Doręczenie do 12:00
NADSOB Nadanie w sobotę
NADSWI Nadanie w niedzielę lub święto
PRZET Przetarg monitorowany
DORAK Doręczenie do rąk własnych
PREDSMS Predict  SMS
SMSPAK Pakiet Awizo SMS
PREDEMAIL Predict E-mail
EMAILA Awizo E-mail
EMAILPAK Pakiet Awizo E-mail
SPPCOD SPP COD Pobranie
PDI Informacja przed doręczeniem PDI
DORSWI Doręczenie w niedzielę lub święto
DOR0900 Doręczenie do 9:00
DOR1000 Doręczenie do 10:00
DOR17001900 Doręczenie w godzinach 17:00-19:00
DOR19002200 Doręczenie w godzinach 19:00-22:00
ZALAPAL Załadunek Palety
ROZLPAL Rozładunek Palety
WNIE Wniesienie
ZNIENAD Zniesienie u Nadawcy
ZNIEODB Zniesienie u Odbiorcy
ROZP Rozpaletowanie
ZWRPAL Zwrot palet
TELKUR Telefon od kuriera
DORHAND Doręczenie do sieci handlowej
SKAPOD Skan POD
POTDORSMS Potwierdzenie doręczenia przesyłki – SMS
POTDOREMAIL Potwierdzenie doręczenia przesyłki – EMAIL
AWSZKSMS Awizacja szkody na przesyłce – SMS
AWSZKEMAIL Awizacja szkody na przesyłce – EMAIL
AWPROSMS Awizacja problematycznej przesyłki – SMS
AWPROEMAIL Awizacja problematycznej przesyłki – EMAIL
AWTELODB Awizacja telefoniczna odbioru
GWDORSMS Gwarantowane doręczenie – SMS
GWDOREMAIL Gwarantowane doręczenie – EMAIL
POTZALPRZE Potwierdzenie założenia przesyłki
ZPO Zwrotne potwierdzenie odbioru
DOR0800 Doręczenie do 8:00
DOR1300 Doręczenie na 13:00
DOR1400 Doręczenie na 14:00
DOR1500 Doręczenie na 15:00
DOR1600 Doręczenie na 16:00
DOR1700 Doręczenie na 17:00
DOR1800 Doręczenie na 18:00
DOR1900 Doręczenie na 19:00
DOR2000 Doręczenie na 20:00

5.3. Dostępność usług dodatkowych

kod usluga_id serwis_id
SMSS 115 42
ROD 151 42
EMAILS 174 42
119
SOB 146 120
ROD 151 120
SOB 146 121
ROD 151 121
SOB 146 122
ROD 151 122
SMSS 115 124
DOR1720 133 124
SOB 146 124
ROD 151 124
EMAILS 174 124
SMSS 115 125
ROD 151 125
EMAILS 174 125
SMSS 115 126
ROD 151 126
EMAILS 174 126
SOB 146 129
ROD 151 129
SMSS 115 130
ROD 151 130
EMAILS 174 130
SOB 146 131
ROD 151 131
EMAILS 174 131
SMSA 238 131
ADRPRY 273 131
DOR1200 284 131
PRZET 288 131
DORAK 290 131
EMAILA 294 131
DOR0900 317 131
DOR1000 318 131
DOR17001900 319 131
DOR19002200 320 131
WNIE 323 131
ZNIENAD 324 131
ZNIEODB 325 131
TELKUR 328 131
DORHAND 329 131
ROD 151 132
EMAILS 174 132
SMSA 238 132
ADRPRY 273 132
DORAK 290 132
EMAILA 294 132
DOR17001900 319 132
DOR19002200 320 132
ZALAPAL 321 132
ROZLPAL 322 132
ZWRPAL 327 132
TELKUR 328 132
DORHAND 329 132
SMSA 238 137
ADRPRY 273 137
TELKUR 328 137
SKAPOD 347 137
POTDORSMS 348 137
POTDOREMAIL 349 137
AWSZKSMS 350 137
AWSZKEMAIL 351 137
AWPROSMS 352 137
AWPROEMAIL 353 137
AWTELODB 354 137
POTZALPRZE 357 137
ROD 151 138
ROD 151 139
ROD 151 140
ROD 151 141
ZPO 358 145
ZPO 358 146
SMSS 115 147
SOB 146 147
ROD 151 147
EMAILS 174 147
DOR1200 284 147
DORSWI 309 147
NADDO5 314 147
DOR0800 359 147
DOR1300 360 147
DOR1400 361 147
DOR1500 362 147
DOR1600 363 147
DOR1700 364 147
DOR1800 365 147
DOR1900 366 147
DOR2000 367 147
SMSS 115 148
SOB 146 148
ROD 151 148
EMAILS 174 148
DOR1200 284 148
DORSWI 309 148
NADDO5 314 148
DOR0800 359 148
DOR1300 360 148
DOR1400 361 148
DOR1500 362 148
DOR1600 363 148
DOR1700 364 148
DOR1800 365 148
DOR1900 366 148
DOR2000 367 148
SMSS 115 149
SOB 146 149
ROD 151 149
EMAILS 174 149
DOR1200 284 149
DORSWI 309 149
NADDO5 314 149
DOR0800 359 149
DOR1300 360 149
DOR1400 361 149
DOR1500 362 149
DOR1600 363 149
DOR1700 364 149
DOR1800 365 149
DOR1900 366 149
DOR2000 367 149
SMSS 115 150
SOB 146 150
ROD 151 150
EMAILS 174 150
DOR1200 284 150
DORSWI 309 150
NADDO5 314 150
DOR0800 359 150
DOR1300 360 150
DOR1400 361 150
DOR1500 362 150
DOR1600 363 150
DOR1700 364 150
DOR1800 365 150
DOR1900 366 150
DOR2000 367 150
SMSS 115 151
SOB 146 151
ROD 151 151
EMAILS 174 151
DOR1200 284 151
DORSWI 309 151
NADDO5 314 151
DOR0800 359 151
DOR1300 360 151
DOR1400 361 151
DOR1500 362 151
DOR1600 363 151
DOR1700 364 151
DOR1800 365 151
DOR1900 366 151
DOR2000 367 151
SMSS 115 152
SOB 146 152
ROD 151 152
EMAILS 174 152
DOR1200 284 152
DORSWI 309 152
NADDO5 314 152
DOR0800 359 152
DOR1300 360 152
DOR1400 361 152
DOR1500 362 152
DOR1600 363 152
DOR1700 364 152
DOR1800 365 152
DOR1900 366 152
DOR2000 367 152
SMSS 115 153
SOB 146 153
ROD 151 153
EMAILS 174 153
DOR1200 284 153
DORSWI 309 153
NADDO5 314 153
DOR0800 359 153
DOR1300 360 153
DOR1400 361 153
DOR1500 362 153
DOR1600 363 153
DOR1700 364 153
DOR1800 365 153
DOR1900 366 153
DOR2000 367 153
SMSS 115 154
SOB 146 154
ROD 151 154
EMAILS 174 154
DOR1200 284 154
DORSWI 309 154
NADDO5 314 154
DOR0800 359 154
DOR1300 360 154
DOR1400 361 154
DOR1500 362 154
DOR1600 363 154
DOR1700 364 154
DOR1800 365 154
DOR1900 366 154
DOR2000 367 154
154
SMSS 115 155
SOB 146 155
ROD 151 155
EMAILS 174 155
DOR1200 284 155
DORSWI 309 155
NADDO5 314 155
DOR0800 359 155
DOR1300 360 155
DOR1400 361 155
DOR1500 362 155
DOR1600 363 155
DOR1700 364 155
DOR1800 365 155
DOR1900 366 155
DOR2000 367 155
SMSS 115 156
SOB 146 156
ROD 151 156
EMAILS 174 156
DOR1200 284 156
DORSWI 309 156
NADDO5 314 156
DOR0800 359 156
DOR1300 360 156
DOR1400 361 156
DOR1500 362 156
DOR1600 363 156
DOR1700 364 156
DOR1800 365 156
DOR1900 366 156
DOR2000 367 156
SMSS 115 157
SOB 146 157
ROD 151 157
EMAILS 174 157
DOR1200 284 157
DORSWI 309 157
NADDO5 314 157
DOR0800 359 157
DOR1300 360 157
DOR1400 361 157
DOR1500 362 157
DOR1600 363 157
DOR1700 364 157
DOR1800 365 157
DOR1900 366 157
DOR2000 367 157
SMSS 115 158
SOB 146 158
ROD 151 158
EMAILS 174 158
DOR1200 284 158
DORSWI 309 158
NADDO5 314 158
DOR0800 359 158
DOR1300 360 158
DOR1400 361 158
DOR1500 362 158
DOR1600 363 158
DOR1700 364 158
DOR1800 365 158
DOR1900 366 158
DOR2000 367 158
SMSS 115 159
SOB 146 159
ROD 151 159
EMAILS 174 159
DOR1200 284 159
DORSWI 309 159
NADDO5 314 159
DOR0800 359 159
DOR1300 360 159
DOR1400 361 159
DOR1500 362 159
DOR1600 363 159
DOR1700 364 159
DOR1800 365 159
DOR1900 366 159
DOR2000 367 159
SMSS 115 160
SOB 146 160
ROD 151 160
EMAILS 174 160
DOR1200 284 160
DORSWI 309 160
NADDO5 314 160
DOR0800 359 160
DOR1300 360 160
DOR1400 361 160
DOR1500 362 160
DOR1600 363 160
DOR1700 364 160
DOR1800 365 160
DOR1900 366 160
DOR2000 367 160

6. Kody błędów

Kod błedu Opis błędu
0 Success
401 Athentication failed
500 Unknown Error
1000 Package (s) not found
1001 Invalid Insurance amount, must be greater or equal to COD amount
1002 Invalid Insurance amount, cannot be greater than X
1003 Invalid COD amount, cannot be greater than X
1004 Point with specified PointId was not found
1005 The selected ServiceId is unknown/unsupported
1006 Invalid ReadyDate date, should be at least equal to Today
1007 Field ShipTo->Name is required
1008 Field ShipTo->Address is required
1009 Field ShipTo->City is required
1010 Field ShipTo->PostCode is required
1011 Field ShipTo->CountryCode is required
1012 Field ShipTo->Email is required
1013 Field ShipTo->Contact is required
1014 Field ShipTo->Person is required
1015 ShipTo section is required
1016 ShipTo CountryCode is invalid
1017 Field ShipFrom->Name is required
1018 Field ShipFrom->Address is required
1019 Field ShipFrom->City is required
1020 Field ShipFrom->PostCode is required
1021 Field ShipFrom->CountryCode is required
1022 Field ShipFrom->Email is required
1023 Field ShipFrom->Contact is required
1024 Field ShipFrom->Person is required
1025 ShipFrom section is required
1026 ShipFrom CountryCode is invalid
1027 Missing Parcels data
1028 Sum of Parcels weight must be greater than 0
1029 Maximum weight of single Parcel (Type=Package) is 70kg
1030 Maximum weight of single Parcel (Type=Envelope) is 1kg
1031 Maximum weight of single Parcel (Type=Pallette) is 700kg
1032 Requested label image format is not supported
1033 Requested ServiceId is not available/unknown
1034 Permission denied
1035 Carrier denied to cancel package(s)
1036 ShipTo combination of city, postal code and country is invalid
1037 ShipFrom combination of city, postal code and country is invalid
1038 Field PickupLocation->Name is required
1039 Field PickupLocation->Address is required
1040 Field PickupLocation->City is required
1041 Field PickupLocation->PostCode is required
1042 Field PickupLocation->CountryCode is required
1043 Field PickupLocation->Email is required
1044 Field PickupLocation->Contact is required
1045 Field PickupLocation->Person is required
1046 PickupLocation section is required
1047 PickupLocation CountryCode is invalid
1048 PickupLocation combination of city, postal code and country is invalid
1049 Pickup time is invalid for this location
1050 Package status for pickup is invalid:
1051 Pickup cannot be realized using assigned payer
1052 Field PickupLocation->MaxPickupDate is required
1053 Field PickupLocation->ReadyDate is required
1054 Field PickupLocation->MaxPickupDate cannot be set to Sunday
1055 Field PickupLocation->MaxPickupDate HOUR cannot be smaller than ReadyDate HOUR
1056 MaxPickupDate is out of scope for given location
1057 Cannot perform pickup for given ReadyDate
1058 ShipTo CountryCode is not allowed
1059 ShipFrom CountryCode is not allowed
1060 PickupLocation CountryCode is not allowed
1100 Cannot generate new package number
1101 Parcel format is not supported
1102 Palette and non-palette parcels cannot be mixed
1103 The selected ServiceId is unavailable
1104 Additional service is not defined properly:
1105 Additional service cannot be specified more than once
1106 Additional service code format cannot be empty
1107 ServiceId format is invalid
1108 No package specified in request
1109 Cannot fullfil request, package status is invalid:
1110 Package number cannot be null/empty
1111 Tracking data is not available for given package number
1112 Can’t find any package with given number
1113 Internal error occurred during updating package status: invalid count check
1114 Cannot get company details assigned to current user
1115 Company details for current user are not valid:
1116 Package type is not valid with current service:
1117 Package weight is not valid with current service:
1118 Package size (lenght+perimeter) is not valid with current service:
1119 Package size is not valid with current service:
1120 ShipTo->Email is required for AdditionalService=’EMAIL’
1122 Package size (sum of dimensions) is not valid with current service
1127 Create return label: package is older than 30days
1128 Service “OW (Pick up your own)” is not available for this location
1221 Additional service not supported
6001 PointId is invalid
7001 ReportType is invalid
7002 ReportGuid format is invalid
7003 Could not find report data

7. Dodatkowe informacje i kontakt

Odpowiedzi na wszelkie pytania oraz dodatkowe informacje uzyskać można kontaktując się z nami:

 

Wsparcie techniczne:

helpdesk@bmcg.pl