- Created by Joanna Wołosz, last modified on Sept 20, 2024
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 22 Next »
Metoda przekazująca aktualizacje koszyka jakie klient wykonał w aplikacji InPost Pay. Na otrzymany event informujący Merchanta o zmianie na koszyku, Merchant w response powinien przesłać cały zaktualizowanych koszyk.
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}/event
Parameters
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Unikalny identyfikator koszyka nadawany przez merchanta | string | Y |
|
Request
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Id eventu | string | Y | |
| Data i czas wystąpienia eventu | string($date-time) | Y | |
| Typ eventu. Enum:
| string | Y | |
| Informacja o numerze użytkownika, z którym jest powiązany koszyk | object | O | |
| Prefix | string | Y | |
| Numer telefonu | string | Y | |
| Obiekt zwracający szczegóły eventu |
| O | |
| Identyfikator produktu nadany przez merchanta | string | Y |
|
| Obiekt do przekazania informacji o ilości produktu | object | Y | |
| Ilość produktu | number ($decimal) | Y |
|
| Typ pola quantity. Dostępne wartości Jeżeli
| string | O |
|
| 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 zwracający szczegóły eventu | object | O | |
| Nazwa kodu. W kolejnej wersji aplikacji pole nie wymagalne | string | Y |
|
| Kod promocyjny | string | Y |
|
| Obiekt zwracający szczegóły eventu | object | O | |
| Identyfikator produktu nadany przez merchanta | string | Y |
|
| Ean | string | O |
|
| Obiekt do przekazania informacji o ilości produktu | object | Y | |
| Ilość produktu | number ($decimal) | Y |
|
| Typ pola quantity . dostępne wartości | string | O |
|
| 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 |
|
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 mam możliwość wybrania form płatności przy tworzeniu zamówienia. W przypadku przekazania pustej listy, klientowi zostanie zaprezentowana domyślna lista płatności zgodnie z konfiguracją merchanta w bramce płatniczej z wyłączeniem płatności CASH_ON_DELIVERY. Lista z możliwymi typami płatności: | array | Y |
|
| Obiekt z informacją dodatkową o koszyku, o której merchant chciałby poinformować klienta w aplikacji InPost Pay | object | O | |
| Typ informacji. Wyróżniamy dwa typy informacji, na podstawie której, aplikacji 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 Enum:[
| string | Y |
|
| Sugerowana data dostawy | string($date-time) | Y |
|
| Obiekt służący do przekazania dodatkowych opis dostawy. Obecnie dostępne dwie dodatkowe opcje dostawy:
| 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 dodatkowej 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 wartość 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 niewymagalne | string | Y |
|
| Kod promocyjny | 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 |
|
| Funkcjonalność wykorzystująca obiekt promotions_available dostępna w kolejnych wersjach aplikacji. Obiekt służący do przekazania listy dostępnych promocji dla koszyka | array | O |
|
| Nazwa kodu promocyjnego | string | O | |
| Opis promocji, który będzie prezentowany w aplikacji InPost Pay | string | O | |
| Link do zdjęcia lub loga | string | O | |
| Data startu promocji | string($date-time) | O | |
| Data końca promocji | string($date-time) | O | |
| Priorytet prezentacji oferty na koszyku w aplikacji InPost Pay | integer | O | |
| Obiekt służący do przekazania dokumentów/regulaminów promocji | array | O | |
| Nazwa dokumentu | string | O | |
| Link do dokumentu | string | O | |
| 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: Enum: [
| string | Y |
|
| Jednostka ilości produktu | string | O |
|
| Ilość dostępnego produktu sklepie | number ($decimal) | O |
|
| 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 |
|
| 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, to oznacza że dostawa dostępna wszystkimi typami. | object | O |
|
| Typ dostawy | string | O |
|
| Flaga informująca czy typ dostawy dostępna | 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 |
|
|
| 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: Enum: [ DECIMAL, INTEGER ]
| string | Y |
|
| Jednostka ilości produktu | string | O |
|
| Ilość dostępnego produktu sklepie | number ($decimal) | O |
|
| 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 |
|
| 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 | object | O |
|
| Typ dostawy | string | O |
|
| Flaga informująca czy typ dostawy dostępna | string | O |
|
| Obiekt służący do przekazania listy zgód dla danego koszyka. | array | Y | |
| Id zgody nadawane przez merchanta | string | Y |
|
| Link przekierowujący do pełnej treści zgodny np. do strony merchanta | string | Y |
|
| Label do linku przekazanego w | 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 label_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 | object | Y |
|
| Domena pliku cookie reprezentowana przez parę key-value | string | Y |
|
| Cookie key | string | Y |
|
| Cookie value | string | Y |
|
| Cookie path | string | O |
|
| Czas wygaśnięcia pliku cookie lub maxAge | string($date-time) | O |
|
| Informacje o bezpieczeństwie plików cookie | string | O |
|
| Informacje http o plikach cookie | string | O |
|
| Informacje o pliku cookie sameSite [ STRICT, LAX, NONE ] | string | O |
|
| Priorytet plików cookie [ LOW, MEDIUM, HIGH ] | string | O |
|
| Maksymalny czas cookie | number ($decimal) | O |
|
Przykładowy request
{
"event_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"event_data_time":"2023-08-23T11:14:33.973Z",
"event_type":"PRODUCTS_QUANTITY",
"phone_number": {
"country_prefix":"+48",
"phone":"5xxxxxxxx"
},
"quantity_event_data": [
{
"product_id":"549",
"quantity": {
"quantity":3
}
}
]
}
Response
{
"summary": {
"basket_base_price": {
"net":"249.59",
"gross":"307.00",
"vat":"57.41"
},
"basket_final_price": {
"net":"242.01",
"gross":"297.67",
"vat":"55.66"
},
"basket_promo_price": {
"net":"242.01",
"gross":"297.67",
"vat":"55.66"
},
"currency":"PLN",
"basket_expiration_date":"2023-08-25T11:09:29.000Z",
"basket_additional_information":"",
"payment_type": [
"CARD",
"CARD_TOKEN",
"APPLE_PAY",
"BLIK_CODE",
"BLIK_TOKEN",
"PAY_BY_LINK",
"SHOPPING_LIMIT",
"DEFERRED_PAYMENT",
"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":10678,
"product_category":53,
"ean":"wp-pennant-1",
"product_name":"Klocki Paczkomat InPost z samochodem eko",
"product_description":" \r\n\r\nA wiesz, że każdy jest kurierem własnego życia? Przecież gdy mówisz, to dostarczasz informacje, a jak się uśmiechasz to... dostarczasz radość. Jeszcze większą radość zobaczysz na twarzy dziecka, gdy dostarczysz mu zestaw klocków: paczkomat wraz z ekobusem.\r\n\r\nTo unikalny zestaw, dzięki któremu dzieci mogą wcielić się w rolę kuriera i poczuć jak to jest, gdy dostarcza się same dobre wiadomości czy prezenty. A co najlepsze, klocki pasują do innych klocków konstrukcyjnych co sprawia, że możliwości zabawy stają się nieograniczone.\r\n\r\nKlocki przeznaczone są dla dzieci od 8 lat, ale potrafią obudzić dziecko w człowieku do 80 lat i więcej. W końcu dobra zabawa nie zna wieku.",
"product_link":"https://outofthebox.pl/product/paczkomat-inpost-z-samochodem-eko/",
"product_image":"https://outofthebox.pl/app/uploads/2022/11/INPOST_aranzacje-z-modelami18.jpg",
"base_price": {
"net":"113.01",
"gross":"139.00",
"vat":"25.99"
},
"promo_price": {
"net":"113.01",
"gross":"139.00",
"vat":"25.99"
},
"quantity": {
"quantity":2,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":7507,
"max_quantity":7507
},
"product_attributes": [
{
"attribute_name":"Wymiary/Pojemność",
"attribute_value":"344 cm x 60 cm x 240 cm"
}
]
},
{
"product_id":549,
"product_category":20,
"ean":"0",
"product_name":"Paczkotorba bawełniana",
"product_description":" \r\n\r\nTa torba bawełniana lubi być czysta i wyprana. Lubi, bo jest z bawełny, tak jak wiele Twoich ubrań. Dlatego pralka nie robi jej krzywdy.\r\n\r\nTorba polecana jest szczególnie tym, którzy nie chcą za każdym razem wracać z zakupów z toną jednorazowych woreczków foliowych.\r\n\r\nTorba jest szyta lokalnie. W Polsce, a nie na końcu świata.\r\n\r\nMetr kwadratowy materiału, z którego stworzono torbę, waży 280 gramów. Gdyby miała ręce, włożyłaby sobie do środka spory ciężar i nic by się jej nie stało.\r\n\r\nUwaga: torba InPost ma wielkie uszy, żeby można było ją nosić w stylu out of the box.",
"product_link":"https://outofthebox.pl/product/paczkotorba-bawelniana/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami24-1.jpg",
"base_price": {
"net":"23.58",
"gross":"29.00",
"vat":"5.42"
},
"promo_price": {
"net":"15.99",
"gross":"19.67",
"vat":"3.68"
},
"quantity": {
"quantity":"1",
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":240,
"max_quantity":240
},
"product_attributes":[]
}
],
"related_products": [
{
"product_id":606,
"product_category":17,
"ean":"0",
"product_name":"Paczkokurtka","product_description":" \r\n\r\nNormalne kurtki są normalne.\r\n\r\nPrzód i tył. Lewy rękaw i prawy rękaw. Kaptur i kieszenie.\r\n\r\nKurtki InPost -- są zawsze out of the box! Oprócz wszystkiego, co ma normalna kurtka -- mają jeszcze ogromną kieszeń, są wodoodporne i wiatroszczelne. Ta kieszeń jest tak duża, że może pomieścić w sobie na przykład paczkę. Albo coś innego, co tylko przyjdzie Ci do głowy.\r\nWierzchni materiał pokryty jest powłoką Water Repellent, dzięki czemu woda skrapla się na jego powierzchni\r\n\r\nBo wszystko, co najlepsze, zaczyna się od głowy.\r\nOd pomysłu, który jest inny.\r\n\r\nKtóry jest Out of the box!\r\n\r\nPaczkokurtka InPost dostępna jest w czterech rozmiarach: S, M, L, XL.",
"product_link":"https://outofthebox.pl/product/paczkokurtka-rozm-s/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami25-1.jpg",
"base_price": {
"net":"172.07",
"gross":"211.65",
"vat":"0.00"
},
"promo_price": {
"net":"172.07",
"gross":"211.65",
"vat":"0.00"
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":999,
"max_quantity":999
},
"product_attributes":[]
},
{
"product_id":452,
"product_category":53,
"ean":"0",
"product_name":"Klocki Sortownia",
"product_description":"sdadsadsadasdas",
"product_link":"https://outofthebox.pl/product/sortownia/",
"product_image":"https://outofthebox.pl/app/uploads/2022/10/INPOST_aranzacje-z-modelami17.jpg",
"base_price": {
"net":"186.18",
"gross":"229.00",
"vat":"0.00"
},
"promo_price": {
"net":"186.18",
"gross":"229.00",
"vat":"0.00"
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER",
"quantity_unit":"pcs",
"available_quantity":55844,
"max_quantity":55844
},
"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"
}
]
}
- No labels