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.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	object	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	object	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 CURRIER, to w delivery_product/delivery_related_products powinna być również informacja o dostępności APM i CURRIER).
- 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 CURRIER) 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.

Dano 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	O

do API:

13.06.2024

MAJOR - Obsługa Dyrektywy Omnibus

Wymaganie:

Merchant w przypadku zastosowania kodu, który spełnia warunki określone w Dyrektywie Omnibus na produkcie lub grupie produktów jest zobowiązany do przekazania informacji w szczegółach koszyka:

Wartość produktu po zastosowaniu kodu promocyjnego (products.promo_price)
Oznaczenie kodu promocyjnego jako „OMNIBUS” (promo_codes."regulation_type": "OMNIBUS")
Wartość najniższej ceny produktu z ostatnich 30 dni przed wprowadzeniem promocji na produktach w koszyku dla których został zastosowanych kod omnibusowy (products.lowest_price)

Opis biznesowy:

Przypadek 1: Wykorzystanie przez użytkownika kodu rabatowego merchanta, który spełnia warunki określone w Dyrektywie OMNIBUS.

Merchant musi oznaczyć kod promocyjny jako Omnibus (promo_codes."regulation_type": "OMNIBUS")
Merchant musi przesłać dla każdego produktu, na który ma wpływ zastosowany kod Omnibusowy, cenę Omnibusową na koszyku oraz na szczegółach dodanego do koszyka produktu (products.lowest_price) oraz cenę promocyjną (products.promo_price)
W aplikacji InPost Pay na koszyku dla produktów, dla których został zastosowany kod Omnibusowy zostanie zaprezentowana zarówno cena do zapłaty (products.promo_price) pokazana na czerwono, oraz przekreśloną cenę Omnibusową wraz z informacją, że jest to najniższa cena z 30 dni przed wprowadzeniem promocji (products.lowest_price).
Aplikacja InPost Pay w podsumowaniu koszyka nie będzie prezentowała wartość zastosowanego rabatu („Kod rabatowy sklepu”).

Przypadek 2: Wykorzystanie przez użytkownika kodu rabatowego merchanta, który nie spełnia warunków określonych w Dyrektywie OMNIBUS.

Merchant nie powinien przesyłać dla produktów w koszyku ceny Omnibusowej (products.lowest_price) oraz (products.promo_price).
Aplikacja InPost Pay zaprezentuje przy każdym produkcie cenę podstawową (products.base_price) na czarno.
W przypadku gdy zostanie przekazana wartość w parametrze products.promo_price, to w aplikacji przy produkcie zostanie zaprezentowana cena z products.promo_price na czarno.
Aplikacja InPost Pay w podsumowaniu koszyka zaprezentuje informację „Kod rabatowy sklepu” wraz z sumą obniżki, jaka wynika z zastosowanych kodów rabatowych sklepu. Jeśli zostały zastosowane kody rabatowe na koszyku (nie na produkcie), to wartość zastosowanych rabatów powinna być uwzględniona w basket_promo_price i basket_final_price zgodnie z opisem w dokumentacji.

Dodano: regulation_type

Nazwa pola	Opis	Typ	Wymagalność
`regulation_type`	Typ regulacji lub restrykcji, której kod promocyjny podlega UWAGA: W przypadku gdy, kod promocyjny jest kodem w myśl dyrektywy OMNIBUS to należy przekazać wartość „OMNIBUS”	string	O

do API:

19.04.2024

MINOR - Umożliwienie klientowi przejścia do koszyka w sklepie Merchanta ze szczegółów koszyka w aplikacji InPost Pay.

Użytkownik aplikacji InPost Pay będzie miał możliwości z poziomu szczegółów powiązanego koszyka, przejść do koszyka w sklepie Merchanta. Funkcjonalność będzie dostępna dla koszyków, których Merchant przekaże dane w nowym obiekcie merchant_store umożlwiające poprawne przekierowanie do koszyka użytkownika w sklepie Merchanta z poziomu aplikacji InPost Pay

Dodano obiekt merchant_store

Nazwa pola	Opis	Typ	Wymagalność
`merchant_store`	Obiekt służący do przekazania cookie koszyka klienta w celu umożliwienia przejścia z aplikacji InPost Pay do koszyka w sklepie Merchanta	object	O
`merchant_store.url`	url sklepu	string	Y
`merchant_store.cookies`	Obiekt do przekazania cookie	object	Y
`merchant_store.cookies.domain`	Domena pliku cookie reprezentowana przez parę key-value	string	Y
`merchant_store.cookies.key`	Cookie key	string	Y
`merchant_store.cookies.value`	Cookie value	string	Y
`merchant_store.cookies.path`	Cookie path	string	O
`merchant_store.cookies.expires`	Czas wygaśnięcia pliku cookie lub maxAge	string($date-time)	O
`merchant_store.cookies.secure`	Informacje o bezpieczeństwie plików cookie	string	O
`merchant_store.cookies.http_only`	Informacje http o plikach cookie	string	O
`merchant_store.cookies.same_site`	Informacje o pliku cookie sameSite [ STRICT, LAX, NONE ]	string	O
`merchant_store.cookies.priority`	Priorytet plików cookie [ LOW, MEDIUM, HIGH ]	string	O
`merchant_store.cookies.max_age`	Maksymalny czas cookie	number ($decimal)	O

do API:

28.03.2024

MINOR - Umożliwienie przekazania dodatkowych zdjęć produktów w koszyku.

Zmiana umożliwia przekazanie więcej, niż jednego zdjęcia produktu w koszyku. Po przekazaniu dodatkowych zdjęć, klient będzie miał możliwość w aplikacji InPost Pay na szczegółach produktu przejrzenia przesłanych zdjęć produktu, a tym samy uzyskanie dodatkowych informacji o kupowanym produkcie.

Dodano:

Nazwa pola	Opis	Typ	Wymagalność
`products.additional_product_images`	Obiekt do przekazania dodatkowych zdjęć produktu (lista)	object	O
`products.additional_product_images. small_size`	Zdjęcie produktu. Preferowany rozmiar 360 x 352	string	Y
`products.additional_product_images. normal_size`	Zdjęcie produktu. Preferowany rozmiar 360 x 504	string	Y

do API:

MINOR - Dodanie nowych miejsc osadzenia dla InPost Pay widget.

Nowe miejsca osadzenia widget:

LOGIN_PAGE – strona logowania.
CHECKOUT_PAGE – stona checkout
REGISTERFORM_PAGE – strona rejestracji
MINICART_PAGE - minikarta

Dodano: LOGIN_PAGE, CHECKOUT_PAGE, REGISTERFORM_PAGE, MINICART_PAGE do binding_place w request metody POST/v1/izi/basket/{basket_id}/binding

MINOR - Dodanie flagi if_delivery_free w produkcie sugerowanym w koszyku.

Nazwa pola	Opis	Typ	Wymagalność
`related_products.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	O

w API:

27.03.2024

PATCH - Dodanie maksymalnej ilości zgód w koszyku.

Maksymalna ilość obsługiwanych zgód dla koszyka to 10. W przypadku, gdy w obiekcie consents dla koszyka zostanie przekazanych więcej niż 10 zgód, to w aplikacji InPost Pay będzie obsługiwanych dziesięć pierwszych zgód z obiektu consents. Opis obiektu consents zaktualizowany w artykułach:

06.03.2024

MINOR - Przekazanie więcej, niż jednego linku dla jednej zgody w koszyku do InPost Pay.

Zmiana umożliwia obsługę i prezentacje zgód w aplikacji InPost Pay które mają więcej niż jeden link w treści

Obiekt consents rozszerzony w api:

o dane:

Nazwa pola	Opis	Typ	Wymagalność
`consents.label_link`	Label do linku przekazanego w label_link	string	O
`consents.additional_consent_links`	Obiekt służący do przekazania dodatkowego linku do zgody/regulaminu	object	O
`consents.additional_consent_links.id`	Id zgody nadawane przez merchanta	string	O
`consents.additional_consent_links.consent_link`	Link przekierowujący do pełnej treści zgodny np. do strony merchanta	string	O
`consents.additional_consent_links.label_link`	Label do linku przekazanego w label_link	string	O

MINOR - Umożliwienie przekazania dodatkowego identyfikatora zamówienia przez Merchanta.

Zmiana umożliwia przekazania dodatkowego identyfikatora zamówienia w przypadku, gdy Merchant ma rozwiązanie obsługi zamówień oparte o dwa identyfikatory (jeden służący do komunikacji pomiędzy systemami, drugi do komunikacji i prezentacji klientowi).

Dodano:

Nazwa pola	Opis	Typ	Wymagalność
`customer_order_id`	Identyfikator zamówienia prezentowany klientowi oraz wykorzystywany do płatności. W przypadku braku wykorzystywany jest order_id	string	O

w api:

MINOR - Dodanie pola umożliwiającego przekazania przez Merchanta informacji o wartości zastosowanych rabatów w zamówieniu.

Wartość będzie prezentowana klientowi na podsumowaniu zamówieniu w aplikacji InPost Pay. Dodano:

Nazwa pola	Opis	Typ	Wymagalność
`order_discount`	Wartość zastosowanych kodów rabatowych na zamówieniu	number($decimal)	O

w api:

Changelog

18.06.2024

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

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

13.06.2024

MAJOR - Obsługa Dyrektywy Omnibus

19.04.2024

MINOR - Umożliwienie klientowi przejścia do koszyka w sklepie Merchanta ze szczegółów koszyka w aplikacji InPost Pay.

17.04.2024

MINOR - dodanie metody umożliwiającej sprawdzenie Merchantowi dostępnych metod płatności, jakimi mogą być opłacone utworzone zamówienia w aplikacji InPost Pay.

28.03.2024

MINOR - Umożliwienie przekazania dodatkowych zdjęć produktów w koszyku.

MINOR - Dodanie nowych miejsc osadzenia dla InPost Pay widget.

MINOR - Dodanie flagi if_delivery_free w produkcie sugerowanym w koszyku.

27.03.2024

PATCH - Dodanie maksymalnej ilości zgód w koszyku.

06.03.2024

MINOR - Przekazanie więcej, niż jednego linku dla jednej zgody w koszyku do InPost Pay.

MINOR - Umożliwienie przekazania dodatkowego identyfikatora zamówienia przez Merchanta.

MINOR - Dodanie pola umożliwiającego przekazania przez Merchanta informacji o wartości zastosowanych rabatów w zamówieniu.

26.02.2024

MINOR - Dodano nowy parametr min_height w kodzie widgetu - Widget - frontend

07.02.2024

MINOR - Aktualizacja opisu parametru lowest_price w zakresie wymagalności dla metod:

Parametr lowest_price należy przekazać obligatoryjnie, gdy została przekazana cena promocyjna promo_price.

29.01.2024

PATH - Aktualizacja opisu parametrów account_info.mail i delivery.mail w opisie metody służącej do utworzenia zamówienia -Utworzenie zamówienia

18.12.2023

PATCH - Aktualizacji opisu metod udostępnionych przez InPost Pay (Basket App) poprzez podanie fragmentów kodu i przykładów implementacji w języku PHP.

14.12.2023

PATCH - Aktualizacja opisu dla parametru order_id metody GET /v1/izi/transaction w Zwroty i transakcje

13.12.2023

MAJOR - Dodano nowe parametry max_width oraz frame_style w kodzie html widgetu https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Osadzenie-html

08.11.2023

PATCH - Aktualizacja opisu dla metody iziBindingDelete o uwagi dla developera w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziBindingDelete

03.11.2023

PATCH - Aktualizacja opisu dla parametrów summary.basket_final_price i summary.basket_promo_price w Aktualizacja lub dodanie koszyka ,Potwierdzenie powiązania koszyka ,Pobranie szczegółów koszyka , Aktualizacja koszyka.

30.10.2023

12.10.2023

PATCH Aktualizacja Swagger o opis dla obiektu related_products_event_data - Merchant Backend API

02.10.2023

PATCH Uzupełniono opis metod dla InPost API i Merchant Backend API wraz z parametrami

27.09.2023

PATCH Aktualizacja Swagger - InPost Pay (Basket App)

PATCH Aktualizacja Swagger - Merchant Backend API

15.09.2023

PATCH Aktualizacja Swagger o opis dla delivery_options - InPost Pay (Basket App)

PATCH Aktualizacja Swagger o opis dla delivery_options - Merchant Backend API

MINOR Aktualizacja opisu iziMobileLink - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziMobileLink

07.09.2023

MINOR Aktualizacja Swagger o dodanie free_delivery_minimum_gross_price do metod zwracających szczegóły koszyka i opisanie kodów błędów dla metod API - InPost Pay (Basket App)

MINOR Aktualizacja Swagger o dodanie free_delivery_minimum_gross_price do metod zwracających szczegóły koszyka i opisanie kodów błędów dla metod API - Merchant Backend API

28.08.2023

MAJOR Aktualizacja Swagger o dodanie wymagalności pola order_final_price - InPost Pay (Basket App)

MAJOR Aktualizacja Swagger o dodanie wymagalności pola order_final_price, usunięcie obiektu address_details z response POST/v1/izi/order oraz GET/v1/izi/order/{order_id} - Merchant Backend API

25.08.2023

MINOR Aktualizacja Swagger - Merchant Backend API

08.08.2023

MINOR Uaktualnienie sandbox / prod js link - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Pobranie-skryptu

07.08.2023

PATCH Dodano opis dla wartości pola binding_place - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Osadzenie-html

MINOR Aktualizacja Swagger o dopisanie kodów błędów - InPost Pay (Basket App)

04.08.2023

PATCH Zaktualizowano diagramy sekwencji wraz z opisem dla:

MINOR Aktualizacja Swagger - Merchant Backend API

02.08.2023

MINOR Aktualizacja w Swagger dlaDELETE /v1/izi/basket/{basket_id}/binding oraz DELETE /v1/izi/browser/{browser_id}/binding -InPost Pay (Basket App) POST /v1/izi/order - Merchant Backend API

01.08.2023

MINOR Zaktualizowano diagram sekwencji dla koszyka powiązanego z InPost Pay - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/136806401/Diagramy+sekwencji+dla+InPost+Pay+Widget#UC.01-Koszyk-powi%C4%85zany-z-InPost-Pay

31.07.2023

MINOR Zaktualizowano html w sekcji Osadzanie HTML - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Osadzenie-html

MINOR Dodano informacje o wyświetlaniu w zależności od danych z serwera - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Wy%C5%9Bwietlanie-w-zale%C5%BCno%C5%9Bci-od-parametr%C3%B3w-bindowania

21.07.2023

18.07.2023

MINOR Uzupełnienie iziGetOrderComplete i dodanie informacji o aktualizacji liczby produktów na przycisku - Widget - frontend

MINOR Dodano iziGetBrowserData; handleThankYouNode; opis BrowserId - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziGetBrowserData

PATCH Poprawiono opis iziAddToCart - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziAddToCart

07.07.2023MINOR Aktualizacja opisu “Signature verification algorithm” - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206/Merchant+Backend+API#Algorytm-weryfikacji-sygnatury

06.07.2023MINOR Aktualizacja w obszarze Widget - frontend:

MINOR Dodanie iziGetPayData - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziGetPayData / deprecated iziGetBingingData - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziGetBindingData-(deprecated)

MINOR - Dodano nowy parametr `min_height` w kodzie widgetu - Widget - frontend

PATCH - Aktualizacja opisu dla parametru `order_id` metody `GET` `/v1/izi/transaction` w Zwroty i transakcje

MAJOR - Dodano nowe parametry `max_width` oraz `frame_style` w kodzie html widgetu https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#Osadzenie-html

PATCH - Aktualizacja opisu dla parametrów `summary.basket_final_price` i `summary.basket_promo_price` w Aktualizacja lub dodanie koszyka ,Potwierdzenie powiązania koszyka ,Pobranie szczegółów koszyka , Aktualizacja koszyka.

MINOR Aktualizacja w Swagger dla
DELETE /v1/izi/basket/{basket_id}/binding oraz DELETE /v1/izi/browser/{browser_id}/binding -InPost Pay (Basket App)
POST /v1/izi/order - Merchant Backend API

07.07.2023

MINOR Aktualizacja opisu “Signature verification algorithm” - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206/Merchant+Backend+API#Algorytm-weryfikacji-sygnatury

06.07.2023

MINOR Aktualizacja w obszarze Widget - frontend:

05.07.2023

MINOR Aktualizacja opisu “Signature verification algorithm” - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206/Merchant+Backend+API#Algorytm-weryfikacji-sygnatury

04.07.2023

PATCH Uaktualnienie iziAddToCart - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziAddToCart

PATCH Uaktualnienie opisu metod GET `/v1/izi/baskets` i GET `/v1/izi/orders` w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/129794052/InPost+Pay+Basket+App#InPost-Pay-API%5BhardBreak%5D

30.06.2023

MINOR Uaktualnienie iziGetOrderComplete - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziGetOrderComplete

29.06.2023

MINOR Uaktualnienie iziGetIsBound - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+-+frontend#iziGetIsBound%5BhardBreak%5D