Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
| Status | ||||
|---|---|---|---|---|
|
/v1/izi/basket/{basket_id}/confirmationParameters
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 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 produkt, 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 mam możliwość wybrania form płatności. W przypadku przekazania pustej listy, klientowi zostanie zaprezentowana domyślna lista płatności zgodnie z konfiguracją Merchnata. Lista z możliwych typów 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 |
| 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 |
|
| Lista kodów promocyjnych zastosowanych na koszyku | array | O | |
| Nazwa kodu. W kolejnej wersji aplikacji pole nie wymagalne | string | Y |
|
| Kod promocyjny | 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 |
|
| 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). | 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 |
|
| Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | 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 wariantów produktów. Obiekt obecnie nie wykorzystywany. Funkcjonalność będzie wdrażana w kolejnych wersjach aplikacji. | object | O | |
| Id wariantu | string | Y |
|
| Nazwa wariantu | string | Y |
|
| Opis szczegółowy wariantu | string | O |
|
| Typ wariantu | string | O |
|
| Wartość wariantu | string | 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) |
| 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). | 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 |
|
| Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number | 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 wariantów produktów. Obiekt obecnie nie wykorzystywany. Funkcjonalność będzie wdrażana w kolejnych wersjach aplikacji. | object | O | |
| Id wariantu | string | Y |
|
| Nazwa wariantu | string | Y |
|
| Opis szczegółowy wariantu | string | O |
|
| Typ wariantu | string | O |
|
| Wartość wariantu | string | 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 |
|
| Opis zgody, nie więcej niż 500 znaków | string | Y |
|
| Wersja zgody | string | Y |
|
| Typ zgody. Dostępne wartości Enum: [
| string | Y |
|
Przykładowy request
| Code Block | ||
|---|---|---|
| ||
{
"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
| Code Block | ||
|---|---|---|
| ||
"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": [],
"variants": []
}
],
"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"
}
],
"variants": []
},
{
"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": [],
"variants": []
}
],
"consents": [
{
"consent_id": "3",
"consent_link": "https://outofthebox.pl/zwroty-i-reklamacje/",
"consent_description": "zwroty i reklamacje",
"consent_version": "1",
"requirement_type": "OPTIONAL"
}
]
} |