Changelog

Owned by Michał Machowski
Last updated: Apr 19, 2024 by Joanna Wołosz
5 min read

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.

 

19.04.2024

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

Użytkowinik 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:

 

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. 

https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/365330441/P+atno+ci#Pobranie-listy-dost%C4%99pnych-p%C5%82atno%C5%9Bci-w-InPost-Pay

 

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:

 

 

26.02.2024

MINOR - Dodano nowy parametr min_height w kodzie widgetu -

 

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 -

 

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

 

13.12.2023

MAJOR - Dodano nowe parametry max_width oraz frame_style w kodzie html widgetu

 

08.11.2023

PATCH - Aktualizacja opisu dla metody iziBindingDelete o uwagi dla developera w

 

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

PATCH Uzupełnienie opisu metod iziGetPayData, iziGetIsBound, iziAddToCart dla Widget frontend o przykłady implementacji i przykłady odpowiedzi. Uzupełnienie opisu używanych parametrów o przykłady zastosowania dla

 

12.10.2023

PATCH Aktualizacja Swagger o opis dla obiektu related_products_event_data -

 

02.10.2023

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

 

27.09.2023

PATCH Aktualizacja Swagger -

PATCH Aktualizacja Swagger -

 

15.09.2023

PATCH Aktualizacja Swagger o opis dla delivery_options -

PATCH Aktualizacja Swagger o opis dla delivery_options -

MINOR Aktualizacja opisu 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 -

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 -

 

28.08.2023

major Aktualizacja Swagger o dodanie wymagalności pola order_final_price -

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} -

 

25.08.2023

minor Aktualizacja Swagger -

 

08.08.2023

minor Uaktualnienie sandbox / prod js link -

 

07.08.2023

patch Dodano opis dla wartości pola binding_place -

minor Aktualizacja Swagger o dopisanie kodów błędów -

 

04.08.2023

patch Zaktualizowano diagramy sekwencji wraz z opisem dla:

minor Aktualizacja Swagger -

 

02.08.2023

minor Aktualizacja w Swagger dla
DELETE /v1/izi/basket/{basket_id}/binding oraz DELETE /v1/izi/browser/{browser_id}/binding -
POST /v1/izi/order -

 

01.08.2023

MINOR Zaktualizowano diagram sekwencji dla koszyka powiązanego z InPost Pay -

 

31.07.2023

MINOR Zaktualizowano html w sekcji Osadzanie HTML -

MINOR Dodano informacje o wyświetlaniu w zależności od danych z serwera -

 

21.07.2023

patch Aktualizacja opisu dla “Połączenie koszyka z innym numerem telefonu (Usunięcie/desynchronizacja koszyka powiązanego z InPost Pay) [12-22]: “ -

 

18.07.2023

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

minor Dodano iziGetBrowserData; handleThankYouNode; opis BrowserId -

patch Poprawiono opis iziAddToCart -

 

07.07.2023

minor Aktualizacja opisu “Signature verification algorithm” -

minor Dodano merchant-external-id do /api/v1/izi/signing-keys/public oraz /api/v1/izi/signing-keys/public/{version}. Brak konieczności przekazywania merchant-external-id podczas onboardingu i z requestami.

 

06.07.2023

minor Aktualizacja w obszarze Widget - frontend:

minor Dodanie iziGetPayData - / deprecated iziGetBingingData -

minor Dodanie iziMobileLink -

 

05.07.2023

minor Aktualizacja opisu “Signature verification algorithm” -

 

04.07.2023

patch Uaktualnienie iziAddToCart -

patch Uaktualnienie opisu metod GET /v1/izi/baskets i GET /v1/izi/orders w

 

30.06.2023

minor Uaktualnienie iziGetOrderComplete -

 

29.06.2023

minor Uaktualnienie iziGetIsBound -