Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Metoda do pobrania szczegółów koszyka
Status | ||||
---|---|---|---|---|
|
/v1/izi/basket/{basket_id}
Parameters
Nazwa pola
Opis
Info |
---|
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. |
Status | ||||
---|---|---|---|---|
|
/v1/izi/basket/{basket_id}
Parameters
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Unikalny identyfikator koszyka nadawany przez Merchanta | string | Y |
|
Request – brak
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 produktkoszyku, 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żliwymi typami płatności: | objectarray | 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:
| 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 dodatkowych opcji 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: PWW – paczka w weekend COD – płatność przy odbierze | 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 kwota koszyka od jakiej koszt dostawy będzie wynosił 0 PLN | number ($decimal)(10,2) | O |
| |||||
| Lista kodów promocyjnych zastosowanych na koszyku | 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 |
| ||||
| 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)
| ||||||||
| 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 |
| |||||
| 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 |
| |||||
| 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 |
| |||||
| |||||||||
| 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 | ||||||
| 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).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 informacji o ilości produktu | object | Y |
| Ilość produktuprzekazania 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 |
| |||||
| Typ pola quantity. Dostępne wartości: Jeżeli
| string | Y |
| |||||
| Jednostka ilości produktu | string | O |
| |||||
| Ilość dostępnego produktu sklepie
| ||||||||
| 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) | OY |
| |||||
| 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 |
|
| 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 |
| Typ pola quantity. Dostępne wartości: Jeżeli
| 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 | 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 |
|
| |||||
| 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 sklepie | number ($decimal) | O |
|
| Minimalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number ($decimal) | O |
|
| Maksymalna Minimalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniuzamó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 |
| 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 | 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 koszka. | array | Y | ||||||
| Id zgody nadawane przez Merchanta | string | Y |
| |||||
| Link przekierowujący do pełnej treści zgodny np. do strony merchnata | string | Y |
| |||||
| Label do linku przekazanego w label_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 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:
| 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 |
|