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.

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
colourGreen
titlePOST
/v1/izi/basket/{basket_id}/confirmation

Parameters

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

basket_id

Unikalny identyfikator koszyka nadawany przez Merchanta

string

Y

 

 

Request

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

status

Status autoryzacji wiązania koszyka przez użytkownika wiązania w aplikacji Enum:[ SUCCESS, REJECT ]

SUCCESS - wiązanie zakończona sukcesem

REJECT - - wiązanie odrzucone przez klienta

string

O

inpost_basket_id

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

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

phone_number

Informacje o numerze użytkownika, z którym będzie powiązany koszyk

object

O

country_prefix

Prefix

string

Y

"phone_number":{"country_prefix":"+48","phone":"600000000"}

phone

Numer telefonu

string

Y

browser

Informacje o przeglądarce

object

O

browser_trusted

Flaga informująca czy przeglądarka została do zaufanych

boolean

Y

"browser":{"browser_trusted":true,"browser_id":"fbfac472-3bcc-4c2c-bd41-968032233e03"}

browser_id

Id przeglądarki zaufanej nadany przez InPost Pay. Zwracany w przypadku, gdy browser_trusted=true

string

O

masked_phone_number

Zamaskowany numer telefonu

string

O

"masked_phone_number":"60*****00"

name

Imię użytkownika aplikacji InPost Pay

string

O

"name":"Piotr"

surname

Nazwisko użytkownika aplikacji InPost Pay

string

O

"surname":"Nowak"

 

Response

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

summary

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

object

Y

summary.basket_base_price

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

object

Y

summary.basket_base_price.net

Cena netto

number ($decimal)(10,2)

Y

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

summary.basket_base_price.gross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

summary.basket_base_price.vat

VAT

number ($decimal)(10,2)

Y

summary.basket_final_price

Obiekt służący do przekazania ostatecznej ceny koszyka z uwzględnioną promocją i kodem rabatowym na koszyku bez kosztów dostawy.
Wartość obniżki na koszyku  wynikająca z zastosowania kodu (kodu promocyjnego, który nie reguluje dyrektywa OMNIBUS), widoczna w podsumowaniu koszyka będzie różnicą pomiędzy promo_price a final_price lub base_price a final_price w przypadku gdy koszyk  nie jest w promocji.

object

O

summary.basket_final_price.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

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

summary.basket_final_price.vat

VAT

number ($decimal)(10,2)

Y

summary.basket_promo_price

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

summary.basket_promo_price.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

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

summary.basket_promo_price.vat

VAT

number ($decimal)(10,2)

 

Y

summary.currency

Waluta koszyka. Obecnie obsługiwana tylko waluta PLN

string

Y

"currency":"PLN"

summary.basket_expiration_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

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

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: [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY]

array

Y

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

summary.basket_notice

Obiekt z informacją dodatkową o koszyku, o której Merchant chce poinformować klienta w aplikacji InPost Pay

object

O

summary.basket_notice.type

Typ informacji. Wyróżniamy dwa typy informacji, na podstawie której, aplikacja zaprezentuje odpowiedni format komunikatu Enum: [ ATTENTION, ERROR]

ATTENTION - Wykorzystujemy w przypadku, gdy chcemy poinformować klienta o istotnych informacjach na koszyku, np. zastosowanie kodu promocyjnego, dodanie produktu gratis etc.

ERROR - Wykorzystujemy w przypadku, gdy nie udało się wykonać jakiegoś działania na koszyku np. niepoprawny kod promocyjny lub nie udana próba dodania produktu sugerowanego.

string

Y

"type":"ATTENTION"

summary.basket_notice.description

Treść komunikatu prezentowana klientowi w aplikacji InPost Pay dla danego notice.type

string

Y

"description":"Kod został aktywowany"

delivery

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

array

Y

delivery.delivery_type

Forma dostawy. Dostępne dwie formy Enum:[ APM, COURIER ]

APM - paczkomat, COURIER - kurier InPost

string

Y

"delivery_type":"APM"

delivery.delivery_date

Sugerowana data dostawy

string($date-time)

Y

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

delivery.delivery_options

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

PWW - paczka w weekend

COD - płatność przy odbierze.

W przypadku, gdy dla danego koszyka w payment_type zostanie przekazana wartość CASH_ON_DELIVER, obligatoryjnie należy przekazać COD jako dodatkową opcję dostawy

array

O

delivery.delivery_options.delivery_name

Nazwa dodatkowej opcji dostawy

string

Y

"delivery_name": "Paczka w Weekend"

delivery.delivery_options.delivery_code_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

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

object

Y

delivery.delivery_options.delivery_option_price.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.gorssgross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

delivery.delivery_options.delivery_option_price.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

Cena netto

number ($decimal)(10,2)

Y

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

delivery.delivery_price.gorssgross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

delivery.delivery_price.vat

VAT

number ($decimal)(10,2)

Y

delivery.free_delivery_minimum_gross_price

Minimalna kwota koszyka od jakiej koszt dostawy będzie wynosił 0 PLN

number ($decimal)(10,2)

O

"free_delivery_minimum_gross_price": "100.00"

delivery.estimate_delivery_time

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

"estimate_delivery_time": [
{
"description": "Kup do 15:00 - dostawa jutro",
"days_available": [
"MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY"
],
"start_hour": "10:00",
"end_hour": "15:00"
}
]
}
],

delivery.estimate_delivery_time.description

Treść komunikatu prezentowana klientowi aplikacji

string

Y

delivery.estimate_delivery_time.days_available

Dni tygodnia w jakich ma być prezentowany komunikat

stringarray

O

delivery.estimate_delivery_time.start_hour

Godzina od której ma być prezentowany komunikat

string

O

delivery.estimate_delivery_time.end_hour

Godzina do której ma być prezentowany komunikat

string

O

promo_codes

Lista kodów promocyjnych zastosowanych na koszyku

array

O

promo_codes.name

Nazwa kodu. W kolejnej wersji aplikacji pole nie wymagalne

string

Y

 "name": "Promocja 5%"

promo_codes.regulation_type

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

"regulation_type": "OMNIBUS"

romotionspromotions_available

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

"promotions_available": [
{
"promo_code_value": "MINUS20",
"description": "Wyprzedaże? Kupuj z InPost Pay z rabatem -20zł!",
"image_url": "https://inpostpay.pl//themes/custom/inpost_pay/public/build/images/icons/logo-inpost-pay.svg",
"start_date": "2024-06-12T06:14:57.613Z",
"end_date": "2024-06-12T06:14:57.613Z",
"priority": 0,
"documents": [
{
"name": "Regulamin",
"link": "https://inpost.pl/aktualnosci-wyprzedaze-kupuj-z-inpost-pay-z-rabatem-20zl "
}
]
}
],

promotions_available.promo_code_value

Nazwa kodu promocyjnego

string 

O

promotions_available.description

Opis promocji, który będzie prezentowany w aplikacji InPost Pay

string 

O

promotions_available.image_url

Link do zdjęcia lub loga 

string 

O

promotions_available.start_date

Data startu promocji

string($date-time)

O

promotions_available.end_date

Data końca promocji

string($date-time)

O

promotions_available.priority

Priorytet prezentacji oferty na koszyku w aplikacji InPost Pay

integer

O

promotions_available.documents

Obiekt służący do przekazania dokumentów/regulaminów promocji

array

O

promotions_available.documents.name

Nazwa dokumentu

string 

O

promotions_available.documents.link

Link do dokumentu

string 

O

promo_codes.promo_code_value

Kod promocyjny

string

Y

"promo_code_value": "INPOST10"

products

Lista do przekazania informacji o produktach w koszyku

array

Y

products.product_id

Identyfikator produktu nadany przez Merchanta

string

Y

"product_id":26

products.product_category

Kategoria produktu nadana przez Merchanta

string

O

"product_category":20

products.ean

Ean

string

O

"ean":"0"

products.product_name

Nazwa produktu

string

Y

"product_name":"Plecak washpapa"

products.product_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 do produktu na stronie Merchanta

string

O

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

products.product_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.additional_product_images

Obiekt do przekazania dodatkowych zdjęć produktu (lista)

object

O

-

products.additional_product_images.small_size

Zdjęcie produktu. Preferowany rozmiar 360 x 352

string

Y

-

products.additional_product_images.normal_size

Zdjęcie produktu. Preferowany rozmiar 360 x 504

string

Y

-

products.base_price

Cena podstawowa z produkt

object

Y

 

products.base_price.net

Cena netto

number ($decimal)(10,2)

Y

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

products.base_price.gross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

products.base_price.vat

VAT

number ($decimal)(10,2)

Y

products.promo_price

Cena promocyjna produktu

object

O

 

products.promo_price.net

Cena netto

number ($decimal)(10,2)

Y

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

products.promo_price.gorssgross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

products.promo_price.vat

VAT

number ($decimal)(10,2)

Y

products.lowest_price

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

products.lowest_price.net

Cena netto

number ($decimal)(10,2)

Y

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

products.lowest_price.gorssgross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

products.lowest_price.vat

VAT

number ($decimal)(10,2)

Y

products.quantity

Obiekt do przekazania informacji o ilości produktu

object

Y

products.quantity.quantity

Ilość produktu

number ($decimal)

Y

($decimal)

"quantity":1

products.quantity.quantity_type

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

Jeżeli quantity_type produktu to INTEGER, wtedy Merchant przesyła cenę za 1 sztukę produktu. Jeżeli quantity_type produktu to DECIMAL, wtedy Merchant przesyła cenę za wybraną ilość produktu.  

  • Przykład 1) Mamy 5 sztuk koszul w cenie 10 zł za sztukę. W takim przypadku quantity_type, to INTEGER i cena produktu wynosi 10 zł.

  • Przykład 2) Mamy 0,35 kg mąki w cenie 5 zł. W takim przypadku quantity_type, to DECIMAL i cena produktu wynosi 5 zł.

string

Y

"quantity_type":"INTEGER"

products.quantity.quantity_unit

Jednostka ilości produktu

string

O

"quantity_unit":"pcs"

products.quantity.available_quantity

Ilość dostępnego produktu w sklepie

number ($decimal)

O

"available_quantity":26

products.quantity.min_quantity 

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

number ($decimal) 

 

"min_quantity": 2

products.quantity.max_quantity

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

number ($decimal)

O

"max_quantity":26

products.quantity.quantity_jump

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

"quantity_jump": 0.5

products.product_attributes

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

array

O

products.product_attributes.attribute_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

Wartość atrybutu

string

Y

products.variantsdelivery_product

Obiekt służący do przekazania wariantów produktów. Obiekt obecnie nie wykorzystywany. Funkcjonalność będzie wdrażana w kolejnych wersjach aplikacji.informacji o dostępnych formach dostawy dla produktu. Jeśli brak obiektu delivery_product oznacza że dostawa dostępna wszystkimi typami

object

O

-

products.variantsdelivery_product.variantdelivery_idtype

Id wariantuTyp dostawy

string

YO

-

products.variants.variant_name

Nazwa wariantu

string

Ydelivery_product.if_delivery_available

Flaga informująca czy typ dostawy dostępna

boolean

O

-

products.variants.variant_description

Opis szczegółowy wariantu

string

O

-

products.variants.variant_type

Typ wariantu

string

O

-

products.variants.variant_values

Wartość wariantu

string

O

-

products.delivery_product

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

-

products.delivery_product.delivery_type

Typ dostawy

string

O

-

products.delivery_product.if_delivery_available

Flaga informująca czy typ dostawy dostępna

boolean

O

-

related_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

Identyfikator produktu nadany przez Merchanta

string

Y

"product_id":26related_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

Identyfikator produktu nadany przez Merchanta

string

Y

"product_id":26

related_products.product_category

Kategoria produktu nadana przez Merchanta

string

O

"product_category":20

related_products.ean

Ean

string

O

"ean":"0"

related_products.product_name

Nazwa produktu

string

Y

"product_name":"Plecak washpapa"

related_products.product_categorydescription

Kategoria Opis produktu nadana przez Merchanta

string

O

"product_categorydescription":20

related_products.ean

Ean

string

O

related_products.product_description

Opis produktu

string

O

"ean":"0"

related_products.product_name

Nazwa produktu

string

Y

"product_name":"Plecak washpapa"

"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 do produktu na stronie Merchanta

string

O

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

related_products.product_image

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

string

 

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

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

related_products.additional_product_images

Obiekt do przekazania dodatkowych zdjęć produktu (lista)

object

O

-

related_products.additional_product_images.small_size

zdjęcie produktu. Preferowany rozmiar 360 x 352

string

Y

-

related_products.additional_product_images.normal_size

zdjęcie produktu. Preferowany rozmiar 360 x 504

string

Y

-

related_products.base_price

Cena podstawowa z produkt

object

Y

related_products.base_price.net 

Cena netto

number ($decimal)(10,2)

Y

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

related_products.base_price.gross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

related_products.base_price.vat

VAT

number ($decimal)(10,2)

Y

related_products.promo_price

Cena promocyjna produktu

object

O

related_products.promo_price.net 

Cena netto

number ($decimal)(10,2)

Y

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

related_products.promo_price.gross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

related_products.promo_price.vat

VAT

number ($decimal)(10,2)

 

Y

related_products.lowest_price

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

related_products.lowest_price.net 

Cena netto

number ($decimal)(10,2)

Y

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

related_products.lowest_price.gorssgross

Cena brutto (netto + VAT)

number ($decimal)(10,2)

Y

related_products.lowest_price.vat

VAT

number ($decimal)(10,2)

 

Y

related_products.quantity

Obiekt do przekazania informacji o ilości produktu

object

Y

related_products.quantity.quantity

Ilość produktu

number ($decimal)

Y

"quantity":1

related_products.quantity.quantity_type

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

string

Y

"quantity_type":"INTEGER"

related_products.quantity.quantity_unit

Jednostka ilości produktu

string

O

"quantity_unit":"pcs"

related_products.quantity.available_quantity

Ilość dostępnego produktu na sklepie

number

O

"available_quantity":26

related_products.quantity.min_quantity 

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

number ($decimal) 

"min_quantity":2 

related_products.quantity.max_quantity

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

number

O

"max_quantity":26

related_products.quantity.quantity_jump

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

"quantity_jump":0.5

related_products.product_attributes

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

array

O

related_products.product_attributes.attribute_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

Wartość atrybutu

string

Y

related_products.variants

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

related_products.variants.variantproduct_id

Id wariantu

string

Y

-

attributes

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

array

O

related_products.variantsproduct_attributes.variantattribute_name

Nazwa wariantuatrybutu

string

Y

-

related_products.variants.variant_description

Opis szczegółowy wariantu

string

O

-

related_products.variants.variant_type

Typ wariantu

string

O

-

related_products.variants.variant_values

Wartość wariantu

string

O

-"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

Wartość atrybutu

string

Y

related_products.delivery_related_products

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

-

related_products.delivery_related_products.delivery_type

Typ dostawy

string

O

-

related_products.delivery_related_products.if_delivery_available

Flaga informująca czy typ dostawy dostępna

boolean

O

-

related_products.delivery_related_products.if_delivery_free

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

consents

Obiekt służący do przekazania listy zgód dla danego koszyka.
Maksymalna ilość zgód dla koszyka: 10

array

 Y

 

consents.consent_id

Id zgody nadawany przez Merchanta

string

 Y

"consent_id":3

consents.consent_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.label_link

Label do linku przekazanego w label_link

string

O

"label_link": "Regulaminu",

consents.additional_consent_links

Obiekt służący do przekazania dodatkowego linku do zgody/regulaminu

object

O

 

consents.additional_consent_links.id

Id zgody nadawane przez merchanta

string

O

"id": "0"

consents.additional_consent_links.consent_link

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

string

O

"consent_link": "https://uat.outofthebox.pl/privacy-policy/",

consents.additional_consent_links.label_link

Label do linku przekazanego w label_link

string

O

"label_link": "Polityką prywatności"

consents.consent_description

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

string

 Y

consent_description":"zwroty i reklamacje"

consents.consent_version

Wersja zgody

string

 Y

"consent_version":1

consents.requirement_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"

merchant_store

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

-

merchant_store.url

url sklepu 

string

Y

"url": "https://uat.outofthebox.pl/cart/",

merchant_store.cookies

Obiekt do przekazania cookie

object

Y

-

merchant_store.cookies.domain

Domena pliku cookie reprezentowana przez parę key-value

string

Y

"domain": "uat.outofthebox.pl",

merchant_store.cookies.key

Cookie key

string

Y

"key": "wp_woocommerce_session_f3cd21b400c074e165b59837d7a9d0a4",

merchant_store.cookies.value

Cookie value

string

Y

"value": "t_f13664beda2ec455d97546c1ddab8b%7C%7C1699438060%7C%7C1699434460%7C%7Cf77d310ce1f0440cb4812f5043736989",

merchant_store.cookies.path

Cookie path

string

O

"path": "/",

merchant_store.cookies.expires

Czas wygaśnięcia pliku cookie lub maxAge

string($date-time)

O

"expires": "2025-01-16T14:17:02.486Z",

merchant_store.cookies.secure

Informacje o bezpieczeństwie plików cookie

string

O

"secure": false,

merchant_store.cookies.http_only

Informacje http o plikach cookie

string

O

"http_only": true,

merchant_store.cookies.same_site

Informacje o pliku cookie sameSite [ STRICT, LAX, NONE ]

string

O

"same_site": "LAX",

merchant_store.cookies.priority

Priorytet plików cookie [ LOW, MEDIUM, HIGH ]

string

O

"priority": "MEDIUM",

merchant_store.cookies.max_age

Maksymalny czas cookie

number ($decimal)

O

"max_age": 0

Przykładowy request

Code Block
languagejson
{
  "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
languagejson
"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"
        }
    ]
}