Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Na tej stronie

Table of Contents

Informacje ogólne

Expand
titleJak mogę uzyskać dostęp do środowiska produkcyjnego API ShipX?

W celu uzyskania dostępu dla API ShipX prosimy o postępowanie według instrukcji z poniższego linku:
https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf

Expand
titleCzy w API dostępne jest środowisko testowe?

Tak, w API ShipX jest dostępne środowisko testowe (sandbox) adres środowiska testowego: https://sandbox-api-shipx-pl.easypack24.net.

Expand
titleW jaki sposób mogę wygenerować dostęp do środowiska sandbox?

https://sandbox-manager.paczkomaty.pl/ > zakładka Moje konto > API. Aby wygenerować Token i ID organizacji należy uzupełnić wszystkie dane, łącznie z danymi do faktury w zakładce Moje konto > Dane. Do utworzenia przesyłki paczkomatowej niezbędne są środki na koncie, konto doładujesz wirtualnie w zakładce Płatności.

Expand
titleCzy dostępne są gotowe zapytania API?

Tak, gotowe zapytania json można pobrać z linku: [1.3.0] API Informacje ogólne.

Expand
titleAPI zwraca komunikat "401 invalid authorization" co mam zrobić?

Upewnij się, że podałeś podany został poprawny token z zakładki API w https://manager.paczkomaty.pl jeżeli token jest poprawny.

PamiętajNależy pamiętać, aby używać na środowisku produkcyjnym tokenu z https://manager.paczkomaty.pl/auth/login a na środowisku sandbox z https://sandbox-manager.paczkomaty.pl/.

Expand
titleAPI zwraca komunikat "500 server error" co mam zrobić?

Jeżeli API zwraca błąd 500, skorzystaj należy skorzystać z formularza wsparcia integracyjnego https://inpost.pl/formularz-wsparcie i wybierz wybrać kategorię Problem z dostępnością systemu.

Expand
titleAPI zwraca błąd "403 access forbidden fo this token'

API zwraca błąd, w momencie gdy wpisane jest błędne id organizacji. Zaloguj Należy zalogować się do https://manager.paczkomaty.pl i pobierz pobrać id organizacji znajdujące się w zakładce API w https://manager.paczkomaty.pl/auth/login.

Expand
titleJak mogę dodać adres webhook do organizacji

Należy zalogować się do https://manager.paczkomaty.pl/ następnie przejść do zakładki Moje konto > API > Ustawienia organizacji, a następnie należy wkleić adres webhook w Nowy adres webhook i wcisnąć Dodaj do API.

Przesyłka

Expand
titleCzy mogę utworzyć więcej niż jedną paczkę jednym zapytaniem?

Tak, jest taka możliwość z wykorzystaniem zasobu batch: [1.6.4] Tworzenie i podgląd wielu przesyłek.

Expand
titleCzy podczas tworzenia paczki wymagane jest podanie danych nadawcy?

Nie, jeżeli przy tworzeniu paczki nie zostały podane dane nadawcy, zostaną one pobrane z konta API ShipX.

Expand
titleCzy w trybie asnychronicznym, muszę oczekiwać na przygotowanie ofert a następnie ich zakup?

Nie, API ShipX posiada tryb uproszczony, podczas tworzenia paczek należy wskazać serwis, za pomocą którego ma być nadana paczka, a następnie API automatycznie ją opłaca.

Expand
titlePodczas tworzenia przesyłki pobraniowej API zwraca błąd "Insurance should be equal or higher than COD"

Podczas tworzenia paczki pobraniowej należy pamiętać, że paczka musi zostać ubezpieczona minimum na wartość pobrania lub wyższą.

Expand
titleUbezpieczyłem/am paczkę pobraniową, niestety paczka pozostaje w statusie "offer_prepared"

Należy sprawdzić, czy w systemie https://manager.paczkomaty.pl został uzupełniony numer rachunku bankowego. Po uzupełnieniu numeru rachunku, paczki pobraniowe będą tworzyć się prawidłowo.

Expand
titleCzy dla paczki paczkomatowej musimy podawać jej wymiary oraz wagę?

Nie, dla przesyłek paczkomatowych zostały utworzone szablony, które można wykorzystać, aby wskazać skrytkę, do której powinna zostać umieszczona przesyłka:

Nazwa szablonu

Wymiary

Waga

Gabaryt

small

8 x 38 x 64 cm

do 25 kg

Gabaryt A

medium

19 x 38 x 64 cm

do 25 kg

Gabaryt B

large

41 x 38 x 64 cm

do 25 kg

Gabaryt C

Expand
titleCzy dla paczki kurierskiej również możemy wykorzystać szablony?

Zalecamy, aby dla paczek kurierskich przekazywać prawidłowe wymiary oraz wagę.

Code Block
languagejson
"parcels": {
                "dimensions": {
                "length": "10",
                "width": "10",
                "height": "10",
                "unit": "mm"
            },
            "weight": {
                "amount": "10",
                "unit": "kg"
            }
           },

Expand
titleNie mogę zaktualizować danych w przesyłce.

Aktualizować można tylko przesyłki, które nie zostały jeszcze zakupione, tzn. posiadają status createdoffers_prepared albo offer_selected

Expand
titleNie mogę anulować przesyłki.

Aby anulować przesyłkę w ramach określonej organizacji, użytkownik musi być jej członkiem. Dodatkowym warunkiem jest to, aby przesyłka miała status created lub offers_prepared.

Expand
titleCzy w API moge utworzyć paczkę w weekend?

Tak, API ShipX umożliwia tworzenie paczki z usługą Paczka w Weekend: [1.9.0] Paczka w Weekend

Expand
titleKiedy mogę utworzyć paczkę z usługą Paczka w weekend?

Usługa będzie dostępna w określonym oknie czasowym, np. od czwartku od godziny 20:00 do soboty do godziny 13:00. Nie uwzględniamy świąt ani dni wolnych.

Expand
titleUtworzyłem/am przesyłkę, ale nie mogę pobrać etykiety
  • Etykietę można pobrać dla przesyłki opłaconej — w statusie confirmed lub późniejszym.

  • Aby, pobrać etykietę przesyłki użytkownik musi być jej nadawcą.

Expand
titleCzy mogę pobrać więcej niż jedną etykietę za pomocą jednego requestu?

Tak, maksymalnie można pobrać etykiety dla 100 przesyłek. [1.6.0] Pobieranie wielu etykiet

Expand
titleCzy mogę podać zagraniczny numer telefonu

Nie, API ShipX obsługuje wyłącznie polskie numery telefonu, należy podać 9 cyfrowy numer telefonu, bez znaków specjalnych oraz numerów kierunkowych np. „+48”.

Expand
titleAPI zwraca błąd "debt_collection'

Jeżeli jesteś klientem postpaid (posiadasz umowę) sprawdźproszę sprawdzić, czy opłaciłeś została uiszczona opłata za ostatnią fakturę, a następnie skontaktuj się prosimy o kontakt z opiekunem. Jeżeli natomiast jesteś klientem prepaid (bez umowy) sprawdźproszę sprawdzić, czy posiadasz wystarczającą na koncie widnieje odpowiednia ilość środków na koncie.

Expand
titleAPI zwraca błąd "trucker_ID_is_not_set_for_organization'

API zwraca błąd, ponieważ próbują Państwo użyć serwisu kurierskiego, który dostępny jest po podpisaniu umowy kurierskiej. Dla kont prepaid dedykowanym serwisem jest kurier C2C “inpost_courier_c2c”.

Expand
titleChciałem utworzyć paczkę Allegro SMART, ale utworzyła się jako Paczkomat Standard.

W przypadku podania nieodpowiedniego serwisu dla metody dostawy (np. serwisu inpost_locker_standard dla metody Allegro Paczkomaty 24/7), usługa SMART nie będzie dostępna. [1.14.0] Obsługa serwisów SMART

Expand
titleNie mogę utworzyć paczki Allegro SMART na środowisku sandbox.

Aby utworzyć paczkę Allegro SMART na sandbox, należy pobrać dane potrzebne do wygenerowania paczki ze środowiska sandbox Allegro.

Expand
titleDlaczego na środowisku sandbox, tracking zwraca brak informacji?

Na środowisku sandbox, komponent trackingowy jest wyłączony, dlatego też nie ma możliwości sprawdzenia statusu paczki.

Tracking

Expand
titleCzy można wyszukać więcej niż jedną paczkę za pomocą jednego requestu?

Nie ma takiej możliwości, API pozwala na sprawdzenie statusu dla pojedynczej przesyłki.

Expand
titleCzy mogę sprawdzić status paczki utworzonej w zeszłym miesiącu?

Tak, API umożliwia śledzenie statusów paczek 45 dni wstecz.

Statusy

Expand
titleW jaki sposób mogę pobrać listę dostępnych statusów w API?

Sposób pobrania listy statusów opisany jest w dokumentacji: [1.2.0] Statusy

Expand
titleCzy można pobrać statusy w języku angielskim?

Tak, API umożliwia pobranie statusów wraz z ich opisami w języku angielskim. W requeście należy dodać parametr: en_GB.

Punkty odbioru

Kontakt

W przypadku dodatkowych pytań skontaktuj się zapraszamy do kontaktu z nami za pomocą formularza https://inpost.pl/formularz-wsparcie. Nasz zespół postara się pomóc!