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 bez kosztów dostawy.
Wartość obniżki na produktach wynikająca z zastosowania kodu widoczna w podsumowaniu koszyka będzie różnicą pomiędzy promo_price a final_price lub base_price a final_price w przypadku gdy produkty nie są 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 produkt, 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ż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"],
|
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: ATTENTION- wykorzystujemy w przypadku, gdy chcemy poinformować klient 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 nieudana 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 dodatkowych opcji 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_DELIVERY, obligatoryjnie należy przekazać COD jako dodatkową, opcje dostawy
| | 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 dodatkowej 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.gorss
| 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.gorss
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y |
delivery.delivery_price.vat
| VAT | number ($decimal)(10,2) | Y |
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"
|
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.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"
|
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.gorss
| 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). | 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.gorss
| 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 | "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 sklepie | number ($decimal) | O | "available_quantity":26
|
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.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.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 | |
products.variants.variant_id
| Id wariantu | string | Y | -
|
products.variants.variant_name
| Nazwa wariantu | string | Y | -
|
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 | -
|
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":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_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 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"
|
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). | 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.gorss
| 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 sklepie | number ($decimal) | O | "available_quantity":26
|
related_products.quantity.max_quantity
| Maksymalna ilość produktu jaką klient może zamówić np. przy jednym zamówieniu | number ($decimal) | O | "max_quantity":26
|
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.variant_id
| Id wariantu | string | Y | -
|
related_products.variants.variant_name
| Nazwa wariantu | 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 | -
|
consents
| Obiekt służący do przekazania listy zgód dla danego koszka | array | Y | |
consents.consent_id
| Id zgody nadawane przez Merchanta | string | Y | "consent_id":3
|
consents.consent_link
| Link przekierowujący do pełnej treści zgodny np. do strony merchnata | string | Y | "consent_link":"https://test.outofthebox.pl/zwroty-i-reklamacje/"
|
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"
|