Potwierdzenie powiązania koszyka
- Joanna Wołosz
- Michał Machowski
Metoda przekazuje informacje, czy koszyk został powiązany. W przypadku udanego potwierdzenia powiązania koszyka przez użytkownika w aplikacji InPost Pay, Merchant w celu dokończenia procesu w response musi przekazać szczegóły koszyka.
W przypadku, braku przekazania szczegółów koszyka lub błędnych danych w response, koszyk nie zostanie powiązany.
W danej metodzie wymagamy implementacji wszystkich pól wymienionych w tabeli, ponieważ składają się na całość usługi InPost Pay. Część poniższych pól w kolumnie 'Wymagalność' jest oznaczona jako 'O' tj. opcjonalna ze względu na to, że nie wszystkie produkty/koszyki w sklepach internetowych mają przypisane wszystkie parametry, więc koszyk może zostać utworzony, a zamówienie złożone bez nich. Jednak implementacja/wdrożenie wszystkich pól jest biznesowo WYMAGANE.
POST /v1/izi/basket/{basket_id}/confirmation
Parameters
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Unikalny identyfikator koszyka nadawany przez Merchanta | string | Y |
|
Request
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Status autoryzacji wiązania koszyka przez użytkownika wiązania w aplikacji
| string | O |
|
| Identyfikator koszyka nadawany przez aplikacje InPost Pay. Wartość nie wykorzystywana przez Merchanta. Identyfikator docelowo wykorzystywany przez widget w celu umożliwienia prawidłowego przekierowania z poziomu widget do aplikacji InPost Pay
| string | O |
|
| Informacje o numerze użytkownika, z którym będzie powiązany koszyk | object | O |
|
| Prefix | string | Y |
|
| Numer telefonu | string | Y | |
| Informacje o przeglądarce | object | O |
|
| Flaga informująca czy przeglądarka została do zaufanych | boolean | Y |
|
| Id przeglądarki zaufanej nadany przez InPost Pay. Zwracany w przypadku, gdy | string | O | |
| Zamaskowany numer telefonu | string | O |
|
| Imię użytkownika aplikacji InPost Pay | string | O |
|
| Nazwisko użytkownika aplikacji InPost Pay | string | O |
|
Response
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Obiekt służący do przekazania podstawowych danych o koszyku | object | Y |
|
| Obiekt służący do przekazania ceny podstawowej za koszyk bez kosztów dostawy | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt służący do przekazania ostatecznej ceny koszyka z uwzględnioną promocją i kodem rabatowym na koszyku bez kosztów dostawy. | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt służący do przekazania ceny koszyka z uwzględnioną promocją na koszyku, ale bez zastosowania kodu rabatowego i bez kosztów dostawy. | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2)
| Y | |
| Waluta koszyka. Obecnie obsługiwana tylko waluta PLN | string | Y |
|
| Data wygaśnięcia/ważności koszyka. Jest to data, po której koszyk zostanie automatycznie usunięty z aplikacji InPost Pay (straci ważność). Data nie może być przeszła. | string($date-time) | O |
|
| Pole służy do przekazania dodatkowych informacji o koszyku, które z punktu widzenia Merchanta mogą być istotne dla klienta | string | O |
|
| Preferowane formy płatności dla koszyka. Merchant przekazuje listę preferowanych form płatności dla koszyka, z których następnie klient ma możliwość wybrania form płatności. W przypadku przekazania pustej listy, klientowi zostanie zaprezentowana domyślna lista płatności zgodnie z konfiguracją merchanta w bramce płatniczej oraz CASH_ON_DELIVERY, gdy dla danej formy dostawy w Lista z możliwymi typami płatności: | array | Y |
|
| Obiekt z informacją dodatkową o koszyku, o której Merchant chce poinformować klienta w aplikacji InPost Pay | object | O |
|
| Typ informacji. Wyróżniamy dwa typy informacji, na podstawie której, aplikacja zaprezentuje odpowiedni format komunikatu Enum: [
| string | Y |
|
| Treść komunikatu prezentowana klientowi w aplikacji InPost Pay dla danego notice.type | string | Y |
|
| Obiekt służący do przekazania informacji o preferowanych formach dostawy dla danego koszyka | array | Y |
|
| Forma dostawy. Dostępne dwie formy
| string | Y |
|
| Sugerowana data dostawy | string($date-time) | Y |
|
| Obiekt służący do przekazania informacji o dodatkowych opcjach dostawy. Obecnie dostępne dwie dodatkowe opcje dostawy:
W przypadku, gdy dla danego koszyka w | array | O |
|
| Nazwa dodatkowej opcji dostawy | string | Y |
|
| Kod dodatkowej opcji dostawy. Obecnie dostępne dwa kody:
| string | Y |
|
| Obiekt służący do przekazania informacji o koszcie dodatkowe opcji dostawy | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt służący do przekazania informacji o koszcie dostawy | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Minimalna kwota koszyka od jakiej koszt dostawy będzie wynosił 0 PLN | number ($decimal)(10,2) | O |
|
| Funkcjonalność wykorzystująca obiekt dostępna w kolejnych wersjach aplikacji Obiekt służący do przekazania informacji o szacowanym czasie dostawy w przypadku zamówienia towarów przez klienta w określonym czasie. | array | O |
|
| Treść komunikatu prezentowana klientowi aplikacji | string | Y | |
| Dni tygodnia w jakich ma być prezentowany komunikat | array | O | |
| Godzina od której ma być prezentowany komunikat | string | O | |
| Godzina do której ma być prezentowany komunikat | string | O | |
| Lista kodów promocyjnych zastosowanych na koszyku | array | O |
|
| Nazwa kodu. W kolejnej wersji aplikacji pole nie wymagalne | string | Y |
|
| 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 |
|
| Kod promocyjny | string | Y |
|
| Lista dostępnych kodów promocyjnych, które klient może wykorzystać w koszyku. | array | O |
|
| Typ kodu: ONLY_IN_APP - kod dostępny tylko w aplikacji InPost Pay (TYLKO W APCE). | string | Y | |
| Wartość kodu np. DOSTAWA | string | Y | |
| Opis kodu Max: 60 znaków | string | Y | |
| Data początkowa obowiązywania kodu promocyjnego | string($date-time) | O | |
| Data końcowa obowiązywania kodu promocyjnego | string($date-time) | O | |
| Priorytet kodu | integer | O | |
| Szczegóły kodu promocyjnego | object | Y | |
| Link do szczegółów informacji o kodzie promocyjnym w sklepie merchanta. | string | Y | |
| Lista do przekazania informacji o produktach w koszyku | array | Y |
|
| Identyfikator produktu nadany przez Merchanta | string | Y |
|
| Kategoria produktu nadana przez Merchanta | string | O |
|
| Ean | string | O |
|
| Nazwa produktu | string | Y |
|
| Opis produktu | string | O |
|
| Link do produktu na stronie Merchanta | string | O |
|
| Link do zdjęcia produktu. Preferowane formaty: png, jpg (rekomendacja: png bez tła) | string | O |
|
| Obiekt do przekazania dodatkowych zdjęć produktu (lista) | object | O |
|
| Zdjęcie produktu. Preferowany rozmiar 360 x 352 | string | Y |
|
| Zdjęcie produktu. Preferowany rozmiar 360 x 504 | string | Y |
|
| Cena podstawowa z produkt | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Cena promocyjna produktu | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt służący do przekazania najniższej ceny produktu z ostatnich 30 dni. Wymagane w celu obsłużenia dyrektywy Omibus. Obiekt należy przekazać obligatoryjnie w przypadku, gdy została przekazania cena promocyjna produktu (obiekt promo_price) oraz został przekazany kod promocyjny z "regulation_type": "OMNIBUS". | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt do przekazania informacji o ilości produktu | object | Y |
|
| Ilość produktu | number ($decimal) | Y |
|
| Typ pola quantity. Dostępne wartości: [DECIMAL, INTEGER] Jeżeli
| string | Y |
|
| Jednostka ilości produktu | string | O |
|
| Ilość dostępnego produktu w sklepie | number ($decimal) | O |
|
| Funkcjonalność wykorzystująca obiekt dostępna w kolejnych wersjach aplikacji Minimalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number ($decimal)
| O |
|
| Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number ($decimal) | O |
|
| Funkcjonalność wykorzystująca obiekt dostępna w kolejnych wersjach aplikacji Wartość skoku ilości w przypadku zwiększenia/zmniejszenia ilości produktu przez klienta (np. 0,1 lub 0,5 lub 0,01) | number ($decimal) | O |
|
| Obiekt służący do określenia atrybutów produktu | array | O |
|
| Nazwa atrybutu | string | Y |
|
| Wartość atrybutu | string | Y | |
| Obiekt służący do przekazania informacji o dostępnych formach dostawy dla produktu. Jeśli brak obiektu delivery_product oznacza że dostawa dostępna wszystkimi typami | array | O |
|
| Typ dostawy | string | O |
|
| Flaga informująca czy typ dostawy dostępna | boolean | O |
|
| Obiekt służący do przekazania listy produktów sugerowanych dla danego koszyka, które klient może dodać z poziomu aplikacji InPost Pay | array | O |
|
| Identyfikator produktu nadany przez Merchanta | string | Y |
|
| Kategoria produktu nadana przez Merchanta | string | O |
|
| Ean | string | O |
|
| Nazwa produktu | string | Y |
|
| Opis produktu | string | O |
|
| Link do produktu na stronie Merchanta | string | O |
|
| Link do zdjęcia produktu. Preferowane formaty: png, jpg (rekomendacja: png bez tła) | string |
|
Preferowane formaty: png, jpg (rekomendacja: png bez tła) |
| Obiekt do przekazania dodatkowych zdjęć produktu (lista) | object | O |
|
| zdjęcie produktu. Preferowany rozmiar 360 x 352 | string | Y |
|
| zdjęcie produktu. Preferowany rozmiar 360 x 504 | string | Y |
|
| Cena podstawowa z produkt | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Cena promocyjna produktu | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2)
| Y | |
| Obiekt służący do przekazania najniższej ceny produktu z ostatnich 30 dni. Wymagane w celu obsłużenia dyrektywy Omibus. Obiekt należy przekazać obligatoryjnie w przypadku, gdy została przekazania cena promocyjna produktu (obiekt promo_price) oraz został przekazany kod promocyjny z "regulation_type": "OMNIBUS". | object | O |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2)
| Y | |
| Obiekt do przekazania informacji o ilości produktu | object | Y |
|
| Ilość produktu | number ($decimal) | Y |
|
| Typ pola quantity. Dostępne wartości: | string | Y |
|
| Jednostka ilości produktu | string | O |
|
| Ilość dostępnego produktu na sklepie | number | O |
|
| Funkcjonalność wykorzystująca obiekt dostępna w kolejnych wersjach aplikacji Minimalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number ($decimal) | O |
|
| Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number | O |
|
| Funkcjonalność wykorzystująca obiekt dostępna w kolejnych wersjach aplikacji Wartość skoku ilości w przypadku zwiększenia/zmniejszenia ilości produktu przez klienta (np. 0,1 lub 0,5 lub 0,01) | number ($decimal) | O |
|
| Obiekt służący do określenia atrybutów produktu | array | O |
|
| Nazwa atrybutu | string | Y |
|
| Wartość atrybutu | string | Y |
|
| Obiekt służący do przekazania informacji o dostępnych formach dostawy dla produktu. Jeśli brak obiektu delivery_product oznacza że dostawa dostępna wszystkimi typami | array | O |
|
| Typ dostawy | string | O |
|
| Flaga informująca czy typ dostawy dostępna | boolean | O |
|
| 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 |
|
| Obiekt służący do przekazania listy zgód dla danego koszyka. | array | Y |
|
| Id zgody nadawany przez Merchanta | string | Y |
|
| Link przekierowujący do pełnej treści zgodny np. do strony Merchanta | string | Y |
|
| Label do linku przekazanego w consent_link | string | O |
|
| Obiekt służący do przekazania dodatkowego linku do zgody/regulaminu | object | O |
|
| Id zgody nadawane przez merchanta | string | O |
|
| Link przekierowujący do pełnej treści zgodny np. do strony merchanta | string | O |
|
| Label do linku przekazanego w consent_link | string | O |
|
| Opis zgody, nie więcej niż 500 znaków | string | Y |
|
| Wersja zgody | string | Y |
|
| Typ zgody. Dostępne wartości Enum: [
| string | Y |
|
| Obiekt służący do przekazania cookie koszyka klienta w celu umożliwienia przejścia ze aplikacji InPost Pay do koszyka w sklepie merchanta | object | O |
|
| url sklepu | string | Y |
|
| Obiekt do przekazania cookie | array | Y |
|
| Domena pliku cookie reprezentowana przez parę key-value | string | Y |
|
| Cookie key | string | Y |
|
| Cookie value | string | Y |
|
| Cookie path | string | Y |
|
| Czas wygaśnięcia pliku cookie lub maxAge | string($date-time) | O |
|
| Informacje o bezpieczeństwie plików cookie | boolean | O |
|
| Informacje http o plikach cookie | boolean | O |
|
| Informacje o pliku cookie sameSite [ STRICT, LAX, NONE ] | string | O |
|
| Priorytet plików cookie [ LOW, MEDIUM, HIGH ] | string | O |
|
| Maksymalny czas cookie | integer($int32) | O |
|
Przykładowy request
{
"status": "SUCCESS",
"inpost_basket_id": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"phone_number": {
"country_prefix": "+48",
"phone": "5xxxxxxxx"
},
"browser": {
"browser_trusted": true,
"browser_id": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
},
"masked_phone_number": "5x*****xx",
"name": "<secret>",
"surname": "<secret>"
}
Response
"summary": {
"basket_base_price": {
"net": 80.49,
"gross": 99.00,
"vat": 18.51
},
"basket_final_price": {
"net": 80.49,
"gross": 99.00,
"vat": 18.51
},
"basket_promo_price": {
"net": 80.49,
"gross": 99.00,
"vat": 18.51
},
"currency": "PLN",
"basket_expiration_date": "2023-08-25T09:26:01.000Z",
"basket_additional_information":"",
"payment_type": [
"CARD",
"CARD_TOKEN",
"APPLE_PAY",
"BLIK_CODE",
"BLIK_TOKEN",
"PAY_BY_LINK",
"GOOGLE_PAY",
"CASH_ON_DELIVERY"
]
"basket_notice":null
},
"delivery": [
{
"delivery_type": "APM",
"delivery_date": "2023-08-25T12:00:00.000Z",
"delivery_options": [],
"delivery_price": {
"net": 0.00,
"gross": 0.00,
"vat": 0.00
}
},
{
"delivery_type": "COURIER",
"delivery_date": "2023-08-25T12:00:00.000Z",
"delivery_options": [],
"delivery_price": {
"net": 0.00,
"gross": 0.00,
"vat": 0.00
}
}
],
"promo_codes": [],
"products": [
{
"product_id": "585",
"product_category": "20",
"ean": "0",
"product_name": "Drewniane bule",
"product_description": " \r\n\r\nCo to są bule? Na mieście mówią, że „bule to kule na nudy bóle". To gra, w której zasady są proste, a emocje sięgają 10 piętra. Bule to kule. W tym przypadku -- drewniane, z twardego drewna bukowego. Jedna z nich to świnka zwana prosiaczkiem. Taka kruszynka-wieprzowinka.\r\n\r\nCo trzeba mieć, żeby zagrać w bule? Przynajmniej jednego przyjaciela. Albo przyjaciółkę. Albo sąsiada, wujka, kuzynkę, znajomego, brata, siostrę, kolegę. Trzeba też mieć kawałek trawnika, może być bez trawy. Bule to rzucanie kulami w świnkę. Kto rzuci najbliżej, ten wygrywa. Gra w bule jest prosta, choć kule są okrągłe. Dziwne, co nie?",
"product_link": "https://outofthebox.pl/product/drewniane-bule/",
"product_image": "https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje3-1.jpg",
"base_price": {
"net": 80.49,
"gross": 99.00,
"vat": 18.51
},
"promo_price": {
"net": 80.49,
"gross": 99.00,
"vat": 18.51
},
"quantity": {
"quantity": 1,
"quantity_type": "INTEGER",
"quantity_unit": "pcs",
"available_quantity": 275,
"max_quantity": 275
},
"product_attributes": []
}
],
"related_products": [
{
"product_id": "567",
"product_category": "20",
"ean": "0",
"product_name": "Mata do ćwiczeń",
"product_description": " \r\n\r\nNie wiemy, ile korków wystrzelonych w Sylwestra potrzeba do stworzenia korkowej maty do jogi. Ale wiemy, że dzięki niej możesz zacząć całkiem nowy czas w swoim życiu.\r\n\r\nĆwiczenia na niej to prawdziwy body & soul balance.\r\n\r\nZatem rusz swe "body" po naturalny zastrzyk energii i zadbaj o relaks swojej "soul". Warto wiedzieć, że mata korkowa z naturalnego kauczuku ma najlepsze właściwości antypoślizgowe.",
"product_link": "https://outofthebox.pl/product/mata-do-cwiczen/",
"product_image": "https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje25.jpg",
"base_price": {
"net": 202.44,
"gross": 249.00,
"vat": 0.00
},
"promo_price": {
"net": 202.44,
"gross": 249.00,
"vat": 0.00
},
"quantity": {
"quantity": 1,
"quantity_type": "INTEGER",
"quantity_unit": "pcs",
"available_quantity": 197485,
"max_quantity": 197485
},
"product_attributes": [
{
"attribute_name": "Wymiary/Pojemność",
"attribute_value": "183x61 cm, 4 mm grubości"
},
{
"attribute_name": "Materiał",
"attribute_value": "Korek i naturalny kauczuk"
},
{
"attribute_name": "Waga",
"attribute_value": "2.6 kg"
}
]
},
{
"product_id": "554",
"product_category": "20",
"ean": "0",
"product_name": "Paryżanka",
"product_description": " \r\n\r\nCzy wiesz, co tak naprawdę widzą ludzie, kiedy idziesz sobie z paryżanką?\r\n\r\nWidzą, że jesteś EKO. Nie używasz foliowych woreczków jednorazowego użytku.\r\n\r\nWidzą, że jesteś modna. W końcu Paryż to miejsce, w którym od dawna decyduje się o tym, co warto ze sobą nosić.\r\n\r\nParyżanka nie kryje się z tym, że wygląda rewelacyjnie, kiedy jest wypełniona świeżymi owocami.\r\n\r\nWidzą też, że lubisz naturalne materiały, bo paryżanka wykonana jest w 100 procentach z bawełny.\r\n\r\nI że w swoim życiu działasz zgodnie z zasadą out of the box.\r\nPo swojemu. Jak InPost.",
"product_link": "https://outofthebox.pl/product/paryzanka/",
"product_image": "https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje11-1.jpg",
"base_price": {
"net": 23.58,
"gross": 29.00,
"vat": 0.00
},
"promo_price": {
"net": 23.58,
"gross": 29.00,
"vat": 0.00
},
"quantity": {
"quantity": 1,
"quantity_type": "INTEGER",
"quantity_unit": "pcs",
"available_quantity": 468,
"max_quantity": 468
},
"product_attributes": []
}
],
"consents": [
{
"consent_id": "3",
"consent_link": "https://outofthebox.pl/zwroty-i-reklamacje/",
"consent_description": "zwroty i reklamacje",
"consent_version": "1",
"requirement_type": "OPTIONAL"
}
]
}