Page Comparison

basket_id id 

Unikalny identyfikator koszyka nadawany przez merchanta 

string 

Y 

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

browser_id id

Unikalny identyfikator przeglądarki zaufanej nadawany przez aplikacje Inpost. Pole wykorzystywane tylko w przypadku, gdy klient korzysta z przeglądarki zaufanej i nie ma powiązanego koszyka. W takiej sytuacji po wybraniu „Kup z Inpost Pay” powinna być wywołana metoda PUT z parametrem browser_id. 

string 

O 

"browser_id":"2d387d15-d4fe-43f8-85dc-32d46cfc3b53"  

summary

summary 

Obiekt służący do przekazania podstawowych danych o koszyku 

object 

Y   

summary.basket_base_price price

Obiekt służący do przekazania ceny podstawowej za koszyk bez kosztów dostawy 

object 

Y   

summary.basket_base_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"summary":{"basket_base_price":{"net":"250.00","gross":"307.50","vat":"57.5 5"}}

summary.basket_base_price.gross gross

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

summary.basket_base_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

summary.basket_final_price price

Obiekt służący do przekazania ceny koszyka z uwzględnionym kodem rabatowym bez kosztów dostawy. Jeśli nie ma zastosowanego kodu rabatowego: final_price = promo_price 

object 

O   

summary.basket_final_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"basket_final_price":{"net":"220.00","gross":"270.60","vat":"50.60"} 

summary.basket_final_price.gross gross

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

summary.basket_final_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

summary.basket_promo_price price

Obiekt służący do przekazania ceny koszyka z uwzględnioną promocją bez kosztów dostawy 

object 

O 

summary.basket_promo_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"basket_promo_price":{"net":"220.00","gross":"270.60","vat":"50.60"} 

summary.basket_promo_price.gross gross

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

summary.basket_promo_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

summary.currency currency

Waluta koszyka. Obecnie obsługiwana tylko waluta PLN 

string 

Y 

"currency":"PLN" 

summary.basket_expiration_date date

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 

"basket_expiration_date":"2023-09-13T07:40:53.000Z" 

summary.basket_additional_information information

Pole służy do przekazania dodatkowych informacji o koszyku, które z punktu widzenia merchanta mogą być istotne dla klienta 

string 

O 

"basket_additional_information":"Zamów już dziś, a otrzymasz kod promocyjny na przyszłe zakupy" 

summary.payment_type type

Preferowane formy płatności za koszyk. 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ą merchnata. Lista z możliwymi typami płatności: [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY ] 

object 

Y 

"payment_type":["CARD","CARD_TOKEN","APPLE_PAY","BLIK_CODE","BLIK_TOKEN","PAY_BY_LINK","SHOPPING_LIMIT","DEFERRED_PAYMENT","GOOGLE_PAY"], 

delivery delivery

Obiekt służący do przekazania informacji o preferowanych formach dostawy dla danego koszyka 

array 

Y  

delivery.delivery_type type

Forma dostawy. Enum:[ APM, COURIER ].  

APM – paczkomat, COURIER – kurier Inpost 

string 

Y 

"delivery_type":"APM" 

delivery.delivery_date date

Sugerowana data dostawy 

string($date-time) 

O 

"delivery_date":"2023-09-14T12:00:00.000Z" 

delivery.delivery_options options

Obiekt służący do przekazania dodatkowych opis dostawy.  Obecnie dostępne dwie dodatkowe opcje dostawy: 

PWW – paczka w weekend  

COD – płatność przy odbierze. W przypadku, gdy dla danego koszyk w payment_type zostanie przekazana wartość CASH_ON_DELIVERY, obligatoryjnie należy przekazać COD jako dodatkową opcje dostawy 

O  

delivery.delivery_options.delivery_name name

Nazwa dodatkowej opcji dostawy 

string 

Y 

"delivery_name": "Paczka w Weekend"  

delivery.delivery_options.delivery_code_value value

Kod dodatkowej opcji dostawy. Obecnie dostępne dwa kody: 

PWW – paczka w weekend  

COD – płatność przy odbierze 

string 

Y 

"delivery_code_value": "PWW" 

delivery.delivery_options.delivery_option_price price

Obiekt służący do przekazania informacji o koszcie dodatkowych opcji dostawy 

object 

Y  

delivery.delivery_options.delivery_option_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"delivery_option_price ":{"net":"10.00","gross":"12.30","vat":"2.30"} 

delivery.delivery_options.delivery_option_price.gorss gorss

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

delivery.delivery_options.delivery_option_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

delivery.delivery_price 

Obiekt służący do przekazania informacji o koszcie dostawy  

object 

Y  

delivery.delivery_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"delivery_price":{"net":"10.00","gross":"12.30","vat":"2.30"} 

delivery.delivery_price.gorss gorss

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

delivery.delivery_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

delivery.free_delivery_minimum_gross_price price

Minimalna wartość koszyka od jakiej koszt dostawy będzie wynosił 0 PLN 

Number ($decimal)(10,2) 

O 

"free_delivery_minimum_gross_price": “100"100.00” 00"

promo_codes codes

Lista kodów promocyjnych zastosowanych na koszyku 

array 

O   

promo_codes.name name

Nazwa kodu. W kolejnej wersji aplikacji pole nie wymagalne 

string 

Y 

"name": "Promocja 5%"  

promo_codes.promo_code_value value

Kod promocyjny 

string 

Y 

"promo_code_value": "INPOST10" 

products products

Lista do przekazania informacji o produktach w koszyku 

array 

Y  

products.product_id id

Identyfikator produktu nadany przez merchanta 

string 

Y 

"product_id":26 26

products.product_category category

Kategoria produktu nadana przez merchanta 

string 

O 

"product_category":20 20

products.ean ean

Ean 

string 

O 

"ean":"0" 

products.product_name name

Nazwa produktu  

string 

Y 

"product_name":"Plecak washpapa"  

products.product_description description

Opis produktu 

string 

O 

"product_description":" \r\n\r\nCzasem masz ochotę rzucić wszystko, spakować się i wyjechać w Bieszczady? Jest to dobry plan na wakacje. A w ciągu roku po prostu odkrywaj swoje miasto na nowo.\r\n\r\nUdana eksploracja nie obędzie się bez solidnego plecaka ze zwijanym zamknięciem i uszytego z wysokiej jakości materiałów, takiego jak nasz.\r\n\r\nBawełniane pasy zapewnią wygodę noszenia, a washpapa wyrazi Twoje przywiązanie do natury. Pamiętaj! Za każdą przygodą stoi dobry plecak." 

products.product_link link

Link do produktu na stronie merchanta 

string 

O 

"product_link":"https://test.outofthebox.pl/product/plecak-washpapa/" 

products.product_image image

Link do zdjęcia produktu. Preferowane formaty: png, jpg (rekomendacja: png bez tła)  

string 

O 

"product_image":"https://test.outofthebox.pl/img/2022/10/INPOST_aranzacje-z-modelami25-1.jpg" 

Preferowane format: png, jpg (rekomendacja: png bez tła) 

products.base_price price

Cena podstawowa z produkt 

object 

Y   

products.base_price.net net

Cena netto 

Number ($decimal)(10,2) 

Y 

"base_price":{"net":"161.79","gross":"199.00","vat":"37.21"}  

products.base_price.gross gross

Cena brutto (netto + VAT) 

Number ($decimal)(10,2) 

Y 

products.base_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

products.promo_price 

Cena promocyjna produktu 

object 

O   

products.promo_price.net net

Cena netto 

number ($decimal)(10,2) 

Y 

"promo_price":{"net":"160.98","gross":"198.00","vat":"37.02"} 

products.promo_price.gorss gorss

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

products.promo_price.vat vat

VAT 

Number ($decimal)(10,2) 

Y 

products.lowest_price price

Obiekt służący do przekazania najniższej ceny produktu z ostatnich 30 dni. Wymagane w celu obsłużenia dyrektywy Omibus 

object 

O 

products.lowest_price.net net

Cena netto 

number ($decimal)(10,2) 

Y 

"lowest_price ":{"net":"160.98","gross":"198.00","vat":"37.02"} 

products.lowest_price.gorss 

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

products.lowest_price.vat vat

VAT 

number ($decimal)(10,2) 

Y 

products.quantity quantity

Obiekt do przekazania informacji o ilości produktu 

object 

Y   

products.quantity.quantity quantity

Ilość produktu 

number ($decimal) 

Y 

"quantity":1 1

productsproducts.quantity.quantity_type type

Typ quantity. Dostępne wartości: [ DECIMAL, INTEGER ] 

string 

Y 

"quantity_type":"INTEGER" 

products.quantity.quantity_unit unit

Jednostka ilości produktu 

string 

O 

"quantity_unit":"pcs" 

products.quantity.available_quantity quantity

Ilość dostępnego produktu sklepie 

number ($decimal) 

O 

"available_quantity":26 26

products.quantity.max_quantity quantity

Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu 

number ($decimal) 

O 

"max_quantity":26 26

products.product_attributes attributes

Obiekt służący do określenia atrybutów produktu 

array 

O   

products.product_attributes.attribute_name name

Nazwa atrybutu 

string 

Y 

"product_attributes":[{"attribute_name":"Wymiary/Pojemność","attribute_value":"54 cm x 38 cm x 10 cm"},{"attribute_name":"Materiał","attribute_value":"Washable paper standard + kodura + pasy bawełniane tkane"}] 

products.product_attributes.attribute_value value

Wartość atrybutu 

string 

Y 

products.variants variants

Obiekt obecnie nie wykorzystywany. Funkcjonalność będzie wdrażana w kolejnych wersjach aplikacji. 

object 

O  

products.variants.variant_id id

Id wariantu 

string 

Y -

products.variants.variant_name name

Nazwa wariantu 

string 

Y 

-

products.variants.variant_description description

Opis szczegółowy wariantu 

string 

O -

products.variants.variant_type type

Typ wariantu 

string 

O -

products.variants.variant_values values

Wartość wariantu 

string 

O -

related_products products

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   

related_products.product_id id

Identyfikator produktu nadany przez merchanta 

string 

Y 

"product_id":26 26

related_products.product_category category

Kategoria produktu nadana przez merchanta 

string 

O 

"product_category":20 20

related_products.ean 

Ean 

string 

O 

"ean":"0" 

related_products.product_name name

Nazwa produktu  

string 

Y 

"product_name":"Plecak washpapa" 

related_products.product_description description

Opis produktu 

string 

O 

"product_description":" \r\n\r\nCzasem masz ochotę rzucić wszystko, spakować się i wyjechać w Bieszczady? Jest to dobry plan na wakacje. A w ciągu roku po prostu odkrywaj swoje miasto na nowo.\r\n\r\nUdana eksploracja nie obędzie się bez solidnego plecaka ze zwijanym zamknięciem i uszytego z wysokiej jakości materiałów, takiego jak nasz.\r\n\r\nBawełniane pasy zapewnią wygodę noszenia, a washpapa wyrazi Twoje przywiązanie do natury. Pamiętaj! Za każdą przygodą stoi dobry plecak." 

related_products.product_link link

Link do produktu na stronie merchanta 

string 

O 

"product_link":"https://test.outofthebox.pl/product/plecak-washpapa/" 

related_products.product_image image

Link do zdjęcia produktu. Preferowane formaty: png, jpg (rekomendacja: png bez tła)  

string 

 O

"product_image":"https://test.outofthebox.pl/img/2022/10/INPOST_aranzacje-z-modelami25-1.jpg" 

Preferowane format: png, jpg (rekomendacja: png bez tła) 

related_products.base_price price

Cena podstawowa z produkt 

object 

Y 

related_products.base_price.net net

Cena netto 

number ($decimal)(10,2) 

Y 

"base_price":{"net":"161.79","gross":"199.00","vat":"37.21"}  

related_products.base_price.gross gross

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

related_products.base_price.vat vat

VAT 

number ($decimal)(10,2) 

Y 

related_products.promo_price price

Cena promocyjna produktu 

object 

O  

related_products.promo_price.net net

Cena netto 

number ($decimal)(10,2) 

Y 

"promo_price":{"net":"160.98","gross":"198.00","vat":"37.02"} 

related_products.promo_price.gross gross

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

related_products.promo_price.vat vat

VAT 

number ($decimal)(10,2) 

Y 

related_products.lowest_price price

Obiekt służący do przekazania najniższej ceny produktu z ostatnich 30 dni. Wymagane w celu obsłużenia dyrektywy Omibus 

object 

O  

related_products.lowest_price.net net

Cena netto 

number ($decimal)(10,2) 

Y 

"lowest_price ":{"net":"160.98","gross":"198.00","vat":"37.02"} 

related_products.lowest_price.gorss gorss

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

related_products.lowest_price.vat vat

VAT 

number ($decimal)(10,2) 

Y 

related_products.quantity quantity

Obiekt do przekazania informacji o ilości produktu 

object 

Y   

related_products.quantity.quantity quantity

Ilość produktu 

number ($decimal) 

Y 

"quantity":1  1

related_products.quantity.quantity_type type

Typ quantity. Dostępne wartości: [ DECIMAL, INTEGER ] 

string 

Y 

"quantity_type":"INTEGER" 

related_products.quantity.quantity_unit unit

Jednostka ilości produktu 

string 

O 

"quantity_unit":"pcs" 

related_products.quantity.available_quantity quantity

Ilość dostępnego produktu sklepie 

number($decimal) 

O 

"available_quantity":26 26

related_products.quantity.max_quantity quantity

Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu 

number($decimal) 

O 

"max_quantity":26 26

related_products.product_attributes attributes

Obiekt służący do określenia atrybutów produktu 

array 

O   

related_products.product_attributes.attribute_name name

Nazwa atrybutu 

string 

Y 

"product_attributes":[{"attribute_name":"Wymiary/Pojemność","attribute_value":"54 cm x 38 cm x 10 cm"},{"attribute_name":"Materiał","attribute_value":"Washable paper standard + kodura + pasy bawełniane tkane"}] 

related_products.product_attributes.attribute_value value

Wartość atrybutu 

string 

Y  

related_products.variants variants

Obiekt obecnie nie wykorzystywany. Funkcjonalność będzie wdrażana w kolejnych wersjach aplikacji. 

object 

O 

related_products.variants.variant_id id

Id wariantu 

string 

Y -

related_products.variants.variant_name name

Nazwa wariantu 

string 

Y -

related_products.variants.variant_description description

Opis szczegółowy wariantu 

string 

O -

related_products.variants.variant_type type

Typ wariantu 

string 

O -

related_products.variants.variant_values values

Wartość wariantu 

string 

O 

-

consents consents

Obiekt służący do przekazania listy zgód dla danego koszyka 

array 

 Y

consents.consent_id id

Id zgody nadawane przez merchanta 

string 

 Y

"consent_id":3 3

consents.consent_link link

Link przekierowujący do pełnej treści zgodny np. do strony merchanta 

string 

 Y

"consent_link":"https://test.outofthebox.pl/zwroty-i-reklamacje/" 

consents.consent_description description

Opis zgody, nie więcej niż 500 znaków 

string 

 Y

consent_description":"zwroty i reklamacje" 

consents.consent_version version

Wersja zgody 

string 

 Y

"consent_version":1  1

consents.requirement_type type

Typ zgody. Dostępne wartości: Enum: [OPTIONAL, REQUIRED_ONCE, REQUIRED_ALWAYS ] 

OPTIONAL – Zgoda opcjonalna  

REQUIRED_ONCE - wymagana jednorazowo. Zgoda o takim typie i wersji będzie zapisana w profilu użytkownika, z informacją, że klient wyraził zgodę i w przypadku kolejnych koszyków będzie domyślnie zaznaczona. 

REQUIRED_ALWAYS - wymagana zawsze. Zgoda o takim typie i wersji nie jest zapisywana w profilu użytkownika. Klient za każdym razem musi wyrazić zgodę. 

string 

 Y

"requirement_type":"OPTIONAL" 

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

inpost_basket_id id 

Identyfikator koszyka nadawany przez aplikacje Inpost Pay 

Dana nie wykorzystywana przez merchanta. Identyfikator docelowo wykorzystywany przez widget w celu umożliwienia prawidłowego przekierowania z poziomu widget do aplikacji Inpost Pay 

string 

Y 

"inpost_basket_id": " 866e5bf6-4e8a-443e-98f5-f9b0c5c149dd"