Tworzenie koszyka

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

products

Lista produktów w koszyku.

Zobacz: Struktura obiektu products

array

Y

Lista zawiera przynajmniej 1 element.

phone_number

Numer telefonu kupującego
Zobacz: Struktura obiektu phone_number

object

Y

subscription

Szczegóły subskrypcji, dla której tworzony jest koszyk.

Obiekt przekazywany wyłącznie gdy żądanie dotyczy utworzenia koszyka subskrypcyjnego.

Zobacz: Struktura obiektu subscription

object

O

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

product_id

Identyfikator produktu po stronie merchanta.

string

Y

quantity

Obiekt przekazujący ilość produktu.

Zobacz: Struktura obiektu quantity

object

Y

variant_id

Identyfikator wariantu produktu.

Wymagany tylko gdy produkt posiada warianty. Nie występuje dla koszyka z subskrypcją.

string

O

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

quantity

Ilość produktu

number ($decimal)

Y

Liczba określająca ilość produktu musi być większa od 0.

quantity_type

Typ pola quantity.

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. 

string

O

Enum: [DECIMAL, INTEGER]

quantity_unit

Jednostka miary.

string

O

Np. pcs, kg, m.

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

country_prefix

Prefiks kraju telefonu.

string

Y

Np. +48.

phone

Numer telefonu (same cyfry).

string

Y

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

subscription_definition_key

Klucz definicji subskrypcji.

string

Y

Np. inpost-plus-premium.

subscription_definition_version

Wersja definicji subskrypcji.

string

Y

Np. 1.0.

subscription_plan_id

Identyfikator wybranego planu subskrypcji.

string

Y

subscription_payment_type

Typ płatności subskrypcji.

string

Y

Enum: [ONE_TIME, RECURRENT].

subscription_duration_days

Czas trwania subskrypcji w dniach.

string

Y

Np. 365.

first_payment_date

Data pierwszej płatności.

Dotyczy wyłącznie typu RECURRENT.

string($date-time)

O

Format ISO 8601.

recurrent_payment_amount

Kwota płatności cyklicznej (gross / net / vat).

Zobacz: struktura obiektu price

object

O

consents

Lista zgód powiązanych z subskrypcją. Wymagane zgody, jeśli obecne, muszą być zaakceptowane przez użytkownika przed aktywacją subskrypcji.

Zobacz: Struktura obiektu consents

array

O

Np. regulamin, zgody marketingowe.

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

basket_id

Unikalny identyfikator utworzonego koszyka.

string

Y

products

Lista produktów w koszyku.

Zobacz: Struktura obiektu products

array

Y

summary

Podsumowanie koszyka.

Zobacz: Struktura obiektu summary

object

Y

consents

Lista zgód do koszyka.

Dla koszyków z subskrypcją lista zgód nie jest zwracana - zgody obsługiwane są w obiekcie subscriptionrequestu.

Zobacz: Struktura obiektu consents

array

O

delivery

Lista zawierająca opcje dostawy.

Dla koszyka subskrypcyjnego obiekt zawiera jedynie delivery_type = "NO_DELIVERY", bez pozostałych pól dotyczących dostawy.

Zobacz: Struktura obiektu delivery

array

O

merchant_store

Dane umożliwiające przekierowanie użytkownika z koszyka w aplikacji do koszyka w sklepie merchanta.

W przypadku koszyka z subskrypcją obiekt nie jest przekazywany.

Zobacz: Struktura obiektu merchant_store

object

O

promo_codes

Zastosowane kody promocyjne.

Zobacz: Struktura obiektu promo_codes

array

O

promotions_available

Dostępne promocje dla koszyka.

Zobacz: Struktura obiektu promotions_available

array

O

related_products

Produkty powiązane (cross-sell).
W przypadku koszyka z subskrypcją obiekt nie jest przekazywany.

Zobacz: struktura obiektu related_products

array

O

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

basket_base_price

Cena bazowa koszyka (gross / net / vat).

Zobacz: struktura obiektu price

object

Y

currency

Waluta koszyka.

string

Y

Wartość: PLN.

basket_final_price

Cena finalna koszyka po rabatach (gross / net / vat).

Zobacz: struktura obiektu price

object

O

basket_promo_price

Cena promocyjna koszyka (gross / net / vat).

Zobacz: struktura obiektu price

object

O

basket_expiration_date

Data wygaśnięcia koszyka.

Uwaga: Dla koszyka z subskrypcją pole nie jest przekazywane (null lub pominięte). Ważność koszyka z subskrypcją jest definiowana po stronie InPost.

string($date-time)

O

Format ISO 8601.

basket_notice

Komunikat do wyświetlenia użytkownikowi.

Zobacz: struktura obiektu basket_notice

object

O

basket_additional_information

Dodatkowe informacje o koszyku.

string

O

basket_additional_parameters

Dodatkowe parametry koszyka.

Zobacz: struktura obiektu basket_additional_parameters

array

O

free_basket

Informacja czy koszyk jest bezpłatny.

boolean

O

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

parameters.key

Klucz

string

Y

parameters.value

Wartość

string

Y

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

gross

Cena brutto.

number ($decimal)(10,2)

Y

net

Cena netto.

number ($decimal)(10,2)

Y

vat

Wartość VAT.

number ($decimal)(10,2)

Y

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi