Changelog

Ten artykuł zawiera listę zmian wprowadzonych w dokumentacji wraz z linkami do poszczególnych artykułów. Lista zmian jest uporządkowana według dat modyfikacji.

Kategoria zamian:

major - używana do określania zmian niekompatybilnych wstecznie lub przełomowych względem opublikowanej aktualnie dokumentacji oraz obowiązującej wersji interfejsu API.
minor - używana do określenia kolejnych przyrostów funkcjonalności w dokumentacji oraz interfejsu API, nie powodująca niekompatybilności.
patch - określająca zmiany/poprawki nie powodujące niekompatybilności wstecznej ani przyrostów funkcjonalności oraz zamiany informacyjne.

18.11.2025

PATCH - Usunięto artykuły dotyczące Produktów promowanych

Z dokumentacji usunięto artykuły dotyczące funkcjonalności Produktów promowanych (hot products). Zmiana wynika z wycofania tej funkcjonalności z usługi InPost Pay.

01.09.2025

MINOR - Darmowy koszyk

W aplikacji InPost Pay wprowadzamy możliwość obsługi koszyków darmowych i tworzenia zamówień z koszyków darmowych. Merchant wraz z utworzeniem lub aktualizacją koszyka w aplikacji InPost Pay będzie miał możliwość zdefiniowania, czy koszyk jest darmowy. Flow darmowego koszyka:

Merchant przekazuje koszyk do InPost z nową flagą free_basket = true, która informuje, czy koszyk bez kosztów dostawy jest darmowy.
InPost waliduje czy wartość koszyka jest równa 0.
- Jeśli wartość koszyka bez kosztów dostawy równa się 0, to flaga jest zapisywana szczegółach koszyka. Przejście do następnego kroku.
- Jeśli wartość koszyka bez kosztów dostawy nie równa się 0, to flaga jest ignorowana (oznacza, że koszyk nie jest darmowy). Koniec procesu.
Aplikacja pobiera koszyk z flagą free_basket = true i prezentuje użytkownikowi.
Klient definiuje formę dostawy/dodatkowe opcje dostawy, które mogą wpłynąć na cenę.
- Jeśli całkowita kwota brutto (koszyk+dostawa) = 0, to aplikacja nie prezentuje/pokazuje selektora z płatnościami.
- Jeśli całkowita kwota brutto (koszyk+dostawa) > 0, to aplikacja prezentuje selektor z płatnościami.
Klient naciska „Kupuje i płacę” (przypadek w którym koszyk+dostawa=0).
InPost wykonuje request POST/v1/izi/order do Merchanta w którym dla koszyka, gdzie wartość koszyka + dostawa = 0, są przekazane informacje:
- basket_price.gross=0
- payment_type z nową wartość FREE_ORDER oznaczającą, że jest to darmowe zamówienie.
Merchant tworzy zamówienie i w response POST/v1/izi/order odsyła szczegóły zamówienia z payment_type=FREE_ORDER.
Zamówienie jest zapisywane w InPost jako opłacone oraz prezentowane jest klientowi w aplikacji.
Koniec procesu.

Zakres zmian w API:

Dodanie free_basket do:

endpointy wystawione przez Merchanta:
- response GET/v1/izi/basket/{basket_id} summary.free_basket
- response POST/v1/izi/basket/{basket_id}/confirmation summary.free_basket
- response POST/v1/izi/basket/{basket_id}/event summary.free_basket
endpointy wystawione przez InPost:
- request PUT/v2/izi/basket/{basket_id} summary.free_basket

Obsługa nowego payment_type=FREE_ORDER oznaczającego, że zamówienie jest darmowe na endpointach:

endpointy wystawione przez Merchanta:
- request POST/v1/izi/order - aplikacja przekaże payment_type=FREE_ORDER tylko w przypadku, gdy wartość koszyka z kosztami dostawy będzie równa = 0 i tylko dla koszyka na którym była zdefiniowana flaga free_basket = true.
- response POST/v1/izi/order - Merchant dla utworzonego darmowego zamówienia powinien zwrócić wartość payment_type=FREE_ORDER.
- response GET/v1/izi/order/{order_id} - Merchant dla darmowego zamówienia powinien zwrócić wartość payment_type=FREE_ORDER.
endpointy wystawione przez InPost:
- response GET/v1/izi/orders - jeśli na liście zamówień będzie darmowe zamówienia, to InPost zwróci je z payment_type=FREE_ORDER.

10.07.2025

MINOR - Produkty promowane (Hot products) - link afiliacyjny `product_link`

Obsługa produktów promowanych z wykorzystaniem linku afiliacyjnego.

04.07.2025

PATCH - Dodanie obiektu `basket_additional_parameters`

Merchant wraz z utworzeniem lub aktualizacją koszyka ma możliwość wraz z szczegółami koszyka przekazać dodatkowe parametry, które mogą być wykorzystane np. do powiązania lub identyfikacji koszyka z kampanią lub dodać inne parametry, które ułatwią obsługę koszyka przez Merchanta. Przekazane i zapisane parametry nie są prezentowane w aplikacji.

Dodano obiekt:

    "basket_additional_parameters": [
      {
        "key": "string",
        "value": "string"
      }
    ]

w API:

18.06.2025

PATCH - Nowy wygląd widgetu InPost Pay

Co się zmienia?

Od 24 czerwca zmieni się wygląd widgetu, aby jeszcze lepiej poprowadzić klienta przez proces zakupu. “Kup z InPost Pay” stanie się “Kup z InPost”. Charakter widgetu pozostanie nowoczesny i spójny z naszą marką.

Dodatkowo nowy wygląd widgetu InPost Pay to przede wszystkim nowoczesny design, który jest spójny z aktualnym brandingiem InPost. Ekrany wyświetlane po jego kliknięciu zyskały na przejrzystości i intuicyjności. Dzięki temu kupujący będą jeszcze łatwiej poruszać się po procesie zakupowym w ramach InPost Pay.

Dlaczego wprowadzamy zmiany?

Ulepszona komunikacja procesowa: Nowa komunikacja lepiej informuje klientów o kolejnych krokach, co przekłada się na większe zadowolenie i mniejszą ilość porzuconych koszyków. Dzięki temu, klienci są bardziej świadomi tego, jak utworzyć koszyk i sfinalizować zakupy.
FAQ na poziomie ekranów: Dodajemy nowe FAQ bezpośrednio w widgecie, co jest nowością. Najczęściej zadawane pytania będą teraz dostępne bezpośrednio w procesie zakupowym, co eliminuje konieczność opuszczania ścieżki zakupowej przez użytkownika. To rozwiązanie zwiększa komfort i płynność procesu płatności.

Jakie są korzyści dla sklepów internetowych?

Zwiększenie konwersji: Nowy, atrakcyjny wygląd i intuicyjność widgetu mogą przyciągnąć więcej klientów do finalizacji zakupów. Wzrost kliknięć w widget oraz konwersji został potwierdzony w testach A/B.
Minimalizacja porzuconych koszyków: Dzięki lepszej komunikacji i dostępności FAQ, klienci będą mniej skłonni do przerywania procesu zakupowego.

Operatorzy sklepów internetowych nie muszą nic robić, aby skorzystać z nowego wyglądu widgetu - zmiana nastąpi automatycznie.

W razie pytań, zapraszamy do kontaktu pod adresem: integracjapay@inpost.pl.

06.06.2025

PATH - Dodanie obiektu `order_additional_parameters`

Merchant wraz z utworzeniem (POST /v1/izi/order) lub aktualizacją (GET /v1/izi/order/{order_id}) zmówienia ma możliwość wraz z szczegółami zamówienia przekazać dodatkowe parametry, które mogą być wykorzystane np. do powiązania lub identyfikacji zamówienia z kampanią lub inne które ułatwią obsługę zamówienia przez Merchanta. Przekazane i zapisane parametry nie są prezentowane w aplikacji. Dodatkowe parametry są zwracane wraz z szczegółami zamówienia w GET /v1/izi/orders.

23.04.2025

MAJOR - Obsługa maili użytkownika w zamówieniu

Zmiana opisuje wytyczne w zakresie obsługi maili w zamówieniu, które aplikacja InPost Pay przekazuje do merchanta. Merchant dla prawidłowej obsługi zamówienia oraz przesyłki powinien obligatoryjnie zastosować się do opisanych wytycznych.

Podczas tworzenia zamówienia aplikacja InPost Pay w request POST/v1/izi/order będzie przekazywać maile:

account_info.mail - Mail użytkownika aplikacji InPost Pay. Merchant może wykorzystać powyższy mail tylko do np. założenia konta klienta, weryfikacji użytkownika. Jeżeli użytkownik loguje się do InPost Pay z użyciem Apple, adres email konta zawiera hash nadany przez Apple i ma formę np. abc@privaterelay.appleid.com. Aby Merchant mógł komunikować się z klientem używając tego adresu, domena Merchanta musi być dodana na koncie InPost w Apple. Apple limituje liczbę domen przypisanych do konta do 100. W związku z tym InPost przekazuje do Merchanta adres email abc@mail.inpostpay.pl z tym samym hash, ale w domenie mail.inpostpay.pl.
delivery.mail - Zamaskowany adres mail użytkownika w domenie order.inpostpay.pl, który Merchant obligatoryjnie powinien wykorzystać do obsługi utworzonego zamówienia, w szczególności rejestracji/nadania przesyłki (na mail z delivery.mail należy nadać przesyłkę, co umożliwi prawidłowe monitorowanie i powiązanie utworzonego zamówienia z InPost Pay oraz nadanej przesyłki dla zamówienia).
delivery.digital_delivery_email - Adres email na jaki ma być wysłany produkt cyfrowy. Przekazywany tylko w przypadku, gdy w koszyku znajduje się produkt cyfrowy. Jeśli adres zawiera hash nadany przez Apple i ma formę np. abc@privaterelay.appleid.com. Aby Merchant mógł komunikować się z klientem używając tego adresu, domena Merchanta musi być dodana na koncie InPost w Apple. Apple limituje liczbę domen przypisanych do konta do 100. W związku z tym InPost przekazuje do Merchanta adres email abc@mail.inpostpay.pl z tym samym hash, ale w domenie mail.inpostpay.pl.

26.03.2025

MINOR - Udostępnienie webhooków transakcyjnych w wersji V2 - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/993918980

03.02.2025

MINOR - Produkty promowane (Hot products) - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/881721345

30.01.2025

MINOR - Obsługa produktu cyfrowego oraz dostawy elektronicznej

W aplikacji InPost Pay wprowadzono obsługę produktu cyfrowego oraz dostawy elektronicznej. Merchant będzie miał możliwość definiowania produktu cyfrowego oraz możliwość dostawy elektronicznej dla produktu cyfrowego.

W przypadku, gdy w koszyku znajduje się przynajmniej jeden produkt cyfrowy, użytkownik będzie miał możliwość określenia adresu email na jaki ma być wysłany produkt cyfrowy. Adres email do dostarczenia produktu cyfrowego będzie przekazywany wraz z żądaniem utworzenia zamówienia.

Funkcjonalność dostępna w aplikacji od wersji APP-3.35.0

Zakres zmian:

Dodanie do produktu/produktu sugerowanego w koszyku i zamówieniu parametru określającego typ produktu.

Nazwa pola

Opis

Typ

Wymagalność

product_type

Pole nieobligatoryjne określające typ produktu. Przyjmuje wartość:

PRODUCT - produkt fizyczny
DIGITAL - produkt cyfrowy.

string

O

Jeśli wartość jest null, to aplikacja domyślenie przyjmuje, że produkt jest fizyczny.

W przypadku, gdy merchant w koszyku/zamówieniu przekazuje produkt cyfrowy (lub cyfrowy produkt sugerowany w koszyku), to product_type powinien mieć wartość DIGITAL.

Dodanie do delivery.delivery_type w koszyku wartości DIGITAL
Jeśli koszyk zawiera tylko produkty cyfrowe, to merchant powinien w koszyku przekazać tylko formę dostawy cyfrowej ("delivery_type": "DIGITAL").
Jeśli koszyk zawiera produkty cyfrowe oraz produkty fizyczne, to merchant w obiekcie delivery powinien przekazać dostępne formy dostawy dla produktów fizycznych ("APM" i/lub "CURRIER") oraz "delivery_type": "DIGITAL" dla produktu cyfrowego.
Dodanie do products.delivery_product.delivery_type oraz related_products.delivery_related_products.delivery_type wartość DIGITAL
Jeśli w koszyku jest produkt cyfrowy lub produkt cyfrowy jest w produktach sugerowanych, to należy określić dostępną dostawę dla produktu cyfrowego zgodnie z logiką opisaną w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/164331521/Changelog#MINOR---Informacja-o-dost%C4%99pnej-dostawie-dla-produktu-w-koszyku.
Dodanie do delivery.delivery_type w zamówieniu wartości DIGITAL
Jeśli koszyk zawierał tylko produkty cyfrowe, to w request POST/v1/izi/order w delivery.delivery_type do merchanta zostanie przekazana wartość "DIGITAL". Jeśli koszyk zawierał produkty mieszane, to delivery_type będzie miało wartość zgodnie z wybraną formą dostawy dla produktów fizycznych.
Jeśli utworzone zamówienie przez merchanta zawiera tylko produkty cyfrowe, to delivery.delivery_type w przekazanych szczegółach zamówienia (response POST/v1/izi/order oraz GET/v1/izi/order/{order_id}) do InPost Pay powinno mieć wartość "DIGITAL". Jeśli zamówienie ma produkty mieszane, to delivery_type powinno mieć wartość zgodnie z wybraną formą dostawy dla produktów fizycznych przez klienta (przekazaną w request POST/v1/izi/order).
Dodanie parametru określającego adres email na jaki ma być wysłany produkt cyfrowy (digital_delivery_email) w zamówieniu

Nazwa pola	Opis	Typ	Wymagalność
`digital_delivery_email`	Adres email na jaki ma być wysłany produkt cyfrowy	string	O

Jeśli koszyk zawierał przynajmniej jeden produkt cyfrowy, to w request POST/v1/izi/order w obiekcie delivery aplikacja przekaże adres email do dostarczenia produktu cyfrowego digital_delivery_email.

Jeśli utworzone zamówienie zawiera digital_delivery_email, to merchant powinien zwrócić digital_delivery_email w obiekcie delivery w response POST/v1/izi/order oraz GET/v1/izi/order/{order_id}.

03.10.2024

MINOR - Umożliwienie przekazywania dostępnych kodów promocyjnych z koszykiem klienta do aplikacji InPost Pay

Opis biznesowy:

Merchant wraz z przekazaniem szczegółów koszyka użytkownika ma możliwość przekazania listy dostępnych kodów promocyjnych (maksymalnie 5 kodów), które klient może wykorzystać w koszyku.

Lista dostępnych kodów będzie prezentowana w szczegółach koszyka:

W przypadku użycia kodu przez klienta na koszyku, do merchanta zostanie wywołana metoda do aktualizacji koszyka POST /v1/izi/basket/{basket_id}/event (Aktualizacja koszyka) wraz z wartością użytego kodu. Merchant po otrzymaniu requestu powinien:

zaktualizować koszyk o wartość użytego kodu
zaktualizować listę dostępnych kodów promocyjnych w koszyku
zwrócić zaktualizowany koszyk w response POST /v1/izi/basket/{basket_id}/event

Aplikacja po otrzymaniu zaktualizowanego koszyka zaprezentuje szczegóły koszyka w aplikacji klientowi.

Zakres zmian w API:

Do przekazania kodów na koszyku służy obiekt:

  "promotions_available": [
    {
      "type": "MERCHANT",
      "promo_code_value": "string",
      "description": "string",
      "start_date": "2024-09-20T09:26:39.793Z",
      "end_date": "2024-09-20T09:26:39.793Z",
      "priority": 0,
      "details": {
        "link": "string"
      }
    }
  ],

Nazwa pola	Opis	Typ	Wymagalność
`promotions_available`	Lista dostępnych kodów w koszyku.	array	O
`promotions_available.type`	Typ kodu: Enum:[ MERCHANT, ONLY_IN_APP ] MERCHANT - kod dostępny w sklepie merchanta i InPost Pay (KOD SKLEPU) Przykład prezentacji kodu sklepu w szczegółach koszyka: ONLY_IN_APP - kod dostępny tylko w aplikacji InPost Pay (TYLKO W APCE). Przykład prezentacji kodu dostępnego tylko w aplikacji InPost Pay:	string	Y
`promotions_available.promo_code_value`	Wartość kodu np. DOSTAWA	string	Y
`promotions_available.description`	Opis kodu Max: 60 znaków	string	Y
`promotions_available.start_date`	Data początkowa obowiązywania kodu promocyjnego	string($date-time)	O
`promotions_available.end_date`	Data końcowa obowiązywania kodu promocyjnego	string($date-time)	O
`promotions_available.priority`	Priorytet kodu Priorytet służy do określenia kolejności prezentacji kodów w szczegółach koszyka (najwyższy priorytet ma najniższa wartość).	integer	O
`promotions_available.details`	Szczegóły kodu	object	Y
`promotions_available.details.link`	Link do szczegółów informacji o kodzie promocyjnym w sklepie merchanta.	string	Y

w API:

27.06.2024

PATCH - Wyszukiwanie zamówienia poprzez GET/v1/izi/orders

Dodanie parametru order_id do GET/v1/izi/orders umożliwiającego wyszukiwanie zamówienia po identyfikatorze zamówienia

Parametr order_id dodano do:

Pobranie listy zamówień - Developer Documentations - Confluence (atlassian.net)

18.06.2024

MINOR - Informacja o dostępnej dostawie dla produktu w koszyku

Merchant przekazując do InPost Pay koszyk będzie miał możliwość zdefiniowania jakie są dostępne metody dostawy dla danego produktu w koszyku oraz produktów powiązanych. Do przekazywania powyższej informacji służyć będą obiekty:

delivery_product dla produktów

Nazwa pola	Opis	Typ	Wymagalność
`delivery_product`	Obiekt służący do przekazania informacji o dostępnych formach dostawy dla produktu. Jeśli brak obiektu delivery_product, to oznacza że dostawa dostępna wszystkimi typami	array	O
`delivery_product.delivery_type`	Typ dostawy	string	O
`delivery_product.if_delivery_available`	Flaga informująca czy typ dostawy jest dostępny.	boolean	O

oraz delivery_related_products dla produktów powiązanych

Nazwa pola	Opis	Typ	Wymagalność
`delivery_related_products`	Obiekt służący do przekazania informacji o dostępnych formach dostawy dla produktu. Jeśli brak obiektu delivery_product, to oznacza że dostawa dostępna wszystkimi typami	array	O
`delivery_related_products.delivery_type`	Typ dostawy	string	O
`delivery_related_products.if_delivery_available`	Flaga informująca czy typ dostawy jest dostępny.	boolean	O

Użytkownikowi aplikacji InPost Pay w szczegółach koszyka na produkcie, który ma niedostępną formę dostawy zostanie zaprezentowany odpowiedni komunikat.

Przykład:

Logika przekazywania informacji o dostępnych formach dostawy dla produktu:

Jeśli produkt w koszyku lub produkt powiązany ma dodatkowe ograniczenia w zakresie formy dostawy w stosunku do przekazanych form dostawy w obiekcie delivery, merchant powinien przekazać informacje o formach dostawy dla produktu w delivery_product lub dla produktów powiązanych w delivery_related_products zgodnie z logiką:

Obiekt delivery_product/delivery_related_products powinien zawierać informacje o wszystkich formach dostawy, które zostały przekazane w koszyku w obiekcie delivery (czyli jeśli w obiekcie delivery są zdefiniowane APM i COURIER, to w delivery_product/delivery_related_products powinna być również informacja o dostępności APM i COURIER).
- Jeśli merchant chce zdefiniować, że dana forma dostawy jest dostępna dla danego produktu, to powinien przekazać w delivery_type - forma dostawy np. "APM" i wartość flagi if_delivery_available=true.
  
  { "delivery_type": "APM" "if_delivery_available": true }
- Jeśli merchant chce zdefiniować, że dana forma dostawy jest niedostępna dla danego produktu, to powinien przekazać w delivery_type - forma dostawy np. "APM" i wartość flagi if_delivery_available=false.
  
  { "delivery_type": "APM" "if_delivery_available": false }
W przypadku, gdy w koszyku w obiekcie delivery są zdefiniowane więcej niż jedna forma dostawy (np. AMP i COURIER) i merchant w produkcie w obiekcie delivery_product/delivery_related_products przekaże tylko informacje o dostępności jednej formy dostawy, to forma dostawy która nie została zdefiniowana w delivery_product/delivery_related_products będzie interpretowana jako niedostępna.
- Brak przekazania obiektu delivery_product/delivery_related_products w produkcie oznacza, że dla produktu są dostępne wszystkie formy dostawy, które zostały przekazane w delivery w koszyku.

Obiekt delivery_product oraz delivery_related_products dodano do:

MINOR - Informacja, czy po dodaniu produktu sugerowanego koszyk będzie miał darmową formę dostawy

W produkcie sugerowanym dla danego koszyka merchant ma możliwość przekazania informacji, czy po dodaniu produktu do koszyka wybrana forma dostawy będzie darmowa. Aby przekazać, że wybrana forma dostawy będzie darmowa w obiekcie delivery_related_products należy przekazać:

formę dostawy w delivery_type,
informacje czy dostawa jest dostępna if_delivery_available = true
oraz czy po dodaniu produktu do koszyka dostępna będzie darmowa forma dostawy if_delivery_free=true. Przykład:

        {
          "delivery_type": "APM",
          "if_delivery_available": true,
          "if_delivery_free": true
        }

Aplikacja InPost Pay po otrzymaniu if_delivery_free=true dla danego produktu sugerowanego zaprezentuje odpowiedni komunikat klientowi.

Dodano if_delivery_free:

Nazwa pola	Opis	Typ	Wymagalność
`delivery_related_products.if_delivery_free`	Flaga informująca czy po dodaniu produktu sugerowanego do koszyka, klient będzie miał darmową dostawę. W przypadku, gdy if_delivery_free=true jest na danym produkcie sugerowanym, klientowi zostanie zaprezentowany odpowiedni komunikat na tym produkcie.	boolean