Utworzenie zamówienia
Metoda do utworzenia zamówienia
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.
POST /v1/izi/order
Parameters - brak
Request
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Dane do utworzenia zamówienia | object | Y |
|
| Dodatkowe informacje o zamówieniu | string | O |
|
| Identyfikator koszyka nadany przez merchanta na podstawie którego ma być utworzone zamówienie | string | Y |
|
| Waluta. Obecnie tylko PLN | string | Y |
|
| Całkowita wartość koszyka wraz z kosztami dostawy | object | Y |
|
| Netto | number($decimal) | Y |
|
| Brutto | number($decimal) | Y | |
| VAT | number($decimal) | Y | |
| Wybrana forma płatności przez użytkownika. Dostępne formy Enum: [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY ] | string | Y |
|
| Informacje o koncie użytkowania | object | Y |
|
| Imię | string | Y |
|
| Nazwisko | string | Y |
|
| Numer telefonu | object | Y |
|
| Prefix | string | Y |
|
| Numer telefonu użytkownika | string | Y | |
| Mail użytkownika aplikacji InPost Pay. Merchant może wykorzystać powyższy mail tylko do np. założenia konta klienta, weryfikacji użytkownika. Jeżeli użytkownik loguje się do InPost Pay z użyciem Apple, adres email konta zawiera hash nadany przez Apple i ma formę np. abc@privaterelay.appleid.com. Aby Merchant mógł komunikować się z klientem używając tego adresu, domena Merchanta musi być dodana na koncie InPost w Apple. Apple limituje liczbę domen przypisanych do konta do 100. W związku z tym InPost przekazuje do Merchanta adres email abc@mail.inpostpay.pl z tym samym hash, ale w domenie mail.inpostpay.pl. | string | Y |
|
| Adres użytkownika | object | Y |
|
| Kod kraju | string | Y |
|
| Adres | string | Y | |
| Miasto | string | Y | |
| Kod pocztowy | string | Y | |
| Obiekt do przekazania rozparsowanego adresu | object | O | |
| Ulica | string | O | |
| Numer budynku | string | O | |
| Numer mieszkania | string | O | |
| Dane do faktury | object | O |
|
| Forma prawna Enum: [ PERSON, COMPANY ] | string | O |
|
| Kod kraju | string | O | |
| Id prefix | string | O | |
| Identyfikator podatkowy | string | O | |
| Nazwa firmy | string | O | |
| Imię | string | O | |
| Nazwisko | string | O | |
| Miasto | string | O | |
| Ulica | string | O | |
| Numer budynku | string | O | |
| Numer mieszkania | string | O | |
| Kod pocztowy | string | O | |
| string | O | ||
| Data rejestracji | string | O | |
| Dodatkowe informacje | string | O | |
| Informacje o dostawie | object | Y |
|
| Forma dostawy. Enum:[ APM, COURIER, DIGITAL ]. | string | Y |
|
| Wybrane opcje dostawy - lista | array | O |
|
| Zamaskowany adres mail użytkownika w domenie order.inpostpay.pl, który Merchant obligatoryjnie powinien wykorzystać do obsługi utworzonego zamówienia, w szczególności rejestracji/nadania przesyłki (na mail z delivery.mail należy nadać przesyłkę, co umożliwi prawidłowe monitorowanie i powiązanie utworzonego zamówienia z InPost Pay oraz nadanej przesyłki dla zamówienia). | string | O |
|
| Adres email na jaki ma być wysłany produkt cyfrowy. Przekazywany tylko w przypadku, gdy w koszyk znajduje się produkt cyfrowy. Jeśli adres zawiera hash nadany przez Apple i ma formę np. abc@privaterelay.appleid.com. Aby Merchant mógł komunikować się z klientem używając tego adresu, domena Merchanta musi być dodana na koncie InPost w Apple. Apple limituje liczbę domen przypisanych do konta do 100. W związku z tym InPost przekazuje do Merchanta adres email abc@mail.inpostpay.pl z tym samym hash, ale w domenie mail.inpostpay.pl. | string | O |
|
| Numer telefonu | object | O |
|
| Prefix | string | Y |
|
| Numer | string | Y | |
| Punkt dostawy paczkomatu | string | O |
|
| Adres dostawy | object | O |
|
| Nazwa | string | Y |
|
| Kod kraju | string | O |
|
| Adres | string | Y |
|
| Miasto | string | Y |
|
| Kod pocztowy | string | Y |
|
| Rozprasowany adres | object | O | |
| Ulica | string | O |
|
| Numer budynku | string | O | |
| Numer lokalu | string | O | |
| Uwagi dla kuriera | string | O |
|
| Obiekt służący do przekazania informacji o wyrażonych zgodach przez klienta dla danego zamówienia | array | Y |
|
| Id zgody | string | Y |
|
| Wersja zgody | string | O |
|
| Informacja, czy została wyrażona zgoda | boolean | Y |
|
Response
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Szczegóły zamówienia | object | Y |
|
| Uwagi o zmówieniu | string | O |
|
| Identyfikator zmówienia nadawany przez merchanta | string | Y |
|
| Identyfikator zamówienia prezentowany klientowi oraz wykorzystywany do płatności. W przypadku braku wykorzystywany jest order_id | string | O |
|
| POS id | string | Y |
|
| Data utworzenia zamówienia | string($date-time) | Y |
|
| Identyfikator koszyka, na podstawie którego zostało utworzone zamówienia | string | Y |
|
| Wybrany typ płatności. Enum: [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY ] | string | Y |
|
| Status opisowy prezentowany klientowi w aplikacji InPost Pay - każdy Merchant może przekazać status tak, aby statusy prezentowane w InPost Mobile były zgodne ze statusem prezentowanym klientowi w sklepie Merchanta. | string | Y |
|
| Cena za zamówienie bez kosztów dostawy | object | Y |
|
| Netto | number($decimal) | Y |
|
| Brutto | number($decimal) | Y | |
| VAT | number($decimal) | Y | |
| Cena za zamówienie z uwzględnieniem kosztów dostawy | object | Y |
|
| Netto | number($decimal) | Y |
|
| Brutto | number($decimal) | Y | |
| VAT | number($decimal) | Y | |
| Wartość zastosowanych kodów rabatowych na zamówieniu | number($decimal) | Y |
|
| Waluta zamówienia (obecnie tylko PLN) | string | Y |
|
| Lista nadanych numerów przesyłek zamówienia | array | O |
|
| Obiekt służący do przekazania dodatkowych parametrów zamówienia, które są zapisane w szczegółach zamówienia. Merchant może wykorzystać obiekt np. do zapisania parametrów które umożliwią identyfikacji/powiązanie zamówienia z kampanią. Dodatkowe parametry nie są prezentowane w aplikacji. | array | O |
|
| Klucz | string | Y |
|
| Wartość | string | Y |
|
| Informacje o koncie użytkowania | object | Y |
|
| Imię | string | Y |
|
| Nazwisko | string | Y | |
| Numer telefonu | object | Y | |
| Prefix | string | Y | |