Changelog

Owned by Michał Machowski
Last updated: Nov 12, 2024 by Joanna Wołosz
11 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.

 

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:

image-20241003-131912.png

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ść

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:

image-20241003-132532.png

  • 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:

 

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:

 

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

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

array

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

Y

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

boolean

O

merchant_store.cookies.http_only

Informacje http o plikach cookie

boolean

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

integer($int32)

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. 

Płatności | Pobranie listy dostępnych płatności 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 consent_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:

 

 

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 -https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/201162774

 

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 https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/154271751

 

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+1.0+old+version#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+1.0+old+version#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

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 https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+1.0+old+version#Osadzenie-html

 

12.10.2023

PATCH Aktualizacja Swagger o opis dla obiektu related_products_event_data - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206

 

02.10.2023

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

 

 

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 - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/129794052

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 - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206

 

28.08.2023

major Aktualizacja Swagger o dodanie wymagalności pola order_final_price - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/129794052

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} - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206

 

07.08.2023

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

minor Aktualizacja Swagger o dopisanie kodów błędów - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/129794052

 

02.08.2023

minor Aktualizacja w Swagger dla
DELETE /v1/izi/basket/{basket_id}/binding oraz DELETE /v1/izi/browser/{browser_id}/binding -https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/129794052
POST /v1/izi/order - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/158728206

 

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]: “ - 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

 

18.07.2023

minor Uzupełnienie iziGetOrderComplete i dodanie informacji o aktualizacji liczby produktów na przycisku - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001

minor Dodano iziGetBrowserData; handleThankYouNode; opis BrowserId - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+1.0+old+version#iziGetBrowserData

patch Poprawiono opis iziAddToCart - https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/131072001/Widget+1.0+old+version#iziAddToCart

 

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

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.

 

 

Related pages

InPost Pay (Basket App)
InPost Pay (Basket App)
Developer Documentations
Read with this
Autoryzacja i wymagania techniczne
Autoryzacja i wymagania techniczne
Developer Documentations
Read with this
Aktualizacja lub dodanie koszyka
Aktualizacja lub dodanie koszyka
Developer Documentations
Read with this
Potwierdzenie powiązania koszyka
Potwierdzenie powiązania koszyka
Developer Documentations
Read with this
Widget 1.0 (old version)
Widget 1.0 (old version)
Developer Documentations
Read with this
Merchant Backend API
Merchant Backend API
Developer Documentations
Read with this