Pobranie szczegółów zamówienia
Metoda do pobrania szczegółów zamówienia przez aplikacje InPost Pay od Merchanta.
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.
GET /v1/izi/order/{order_id}
Parameters
Nazwa pola | Opis | Typ | Wymagalność | Dodatkowe uwagi |
| Unikalny identyfikator zamówienia nadawany przez Merchanta | string | Y |
|
Request – brak
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 |
|
| 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 | |
| string | Y |
| |
| Adres użytkownika | object | Y |
|
| Kod kraju | string | Y |
|
| Adres | string | Y | |
| Miasto | string | Y | |
| Kod pocztowy | string | Y | |
| 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 ] | string | Y |
|
| Data dostawy | string($date-time) | Y |
|
| Wybrane opcje dostawy | array | O |
|
| Nazwa | string | Y |
|
| Kod opcji | string | Y | |
| Kwota opcji odstawy | object | Y | |
| Netto | number($decimal) | Y | |
| Brutto | number($decimal) | Y | |
| VAT | number($decimal) | Y | |
| string | O |
| |
| Numer telefonu dla dostawy | object | O |
|
| Prefix | string | Y |
|
| Numer telefonu | string | Y | |
| Punkt dostawy paczkomatu | string | O |
|
| Adres dostawy | object | O |
|
| Nazwa | string | Y |
|
| Kod kraju | string | Y | |
| Adres | string | Y | |
| Miasto | string | Y | |
| Kod pocztowy | string | Y | |
| Obiekt służący do przekazania informacji o koszcie dostawy | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Uwagi dla kuriera | string | O |
|
| Lista produktach w zamówieniu | array | Y |
|
| Identyfikator produktu nadany przez Merchanta | string | Y |
|
| Kategoria produktu nadana przez Merchanta | string | O |
|
| Ean | string | O |
|
| Nazwa produktu | string | Y |
|
| Opis produktu | string | O |
|
| Link do produktu na stronie Merchanta | string | O |
|
| Link do zdjęcia produktu. Preferowane formaty: png, jpg (rekomendacja: png bez tła) | string | O |
|
| Obiekt do przekazania dodatkowych zdjęć produktu (lista) | object | O |
|
| zdjęcie produktu. Preferowany rozmiar 360 x 352 | string | Y |
|
| zdjęcie produktu. Preferowany rozmiar 360 x 504 | string | Y |
|
| Cena produktu uwzględniająca zastosowane rabaty i kody promocyjne na produkcie | object | Y |
|
| Cena netto | number ($decimal)(10,2) | Y |
|
| Cena brutto (netto + VAT) | number ($decimal)(10,2) | Y | |
| VAT | number ($decimal)(10,2) | Y | |
| Obiekt do przekazania informacji o ilości produktu | object | Y |
|
| Ilość produktu | number ($decimal) | Y |
|
| Typ pola quantity. Dostępne wartości: [ DECIMAL, INTEGER ]
| string | 0 |
|
| Jednostka ilości produktu | string | O |
|
| Obiekt służący do określenia atrybutów produktu | array | O |
|
| Nazwa atrybutu | string | Y |
|
| Wartość atrybutu | string | Y | |
| 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
{
"order_details": {
"order_comments":"Uwagi",
"order_id":"xxx",
"pos_id":"xxx",
"order_creation_date":"2023-08-18T13:22:00.000Z",
"basket_id":"xxx",
"order_merchant_status_description":"Oczekiwanie na płatność",
"currency":"PLN",
"order_base_price": {
"net":135.63,
"gross":166.83,
"vat":31.2
},
"payment_type":"BLIK_CODE"
},
"account_info": {
"name":"<secret>",
"surname":"<secret>",
"phone_number": {
"country_prefix":"+48",
"phone":"5xxxxxxxx"
},
"mail":"<secret>",
"client_address": {
"country_code":"<secret>",
"address":"<secret>",
"city":"<secret>",
"postal_code":"<secret>"
}
},
"invoice_details": {
"legal_form":"COMPANY",
"country_code":"<secret>",
"tax_id":"<secret>",
"company_name":"<secret>",
"city":"<secret>",
"street":"<secret>",
"building":"<secret>",
"flat":"<secret>",
"postal_code":"<secret>",
"mail":"<secret>",
"registration_data_edited":"<secret>",
"additional_information":"Adnotacje"
},
"delivery": {
"delivery_type":"COURIER",
"delivery_date":"2023-08-25T10:00:00.000Z",
"mail":"<secret>",
"phone_number": {
"country_prefix":"+48",
"phone":"5xxxxxxxx"
},
"delivery_address": {
"name":"<secret>",
"country_code":"<secret>",
"address":"<secret>",
"city":"<secret>",
"postal_code":"<secret>"
},
"delivery_price": {
"net":10.56,
"gross":12.99,
"vat":2.43
},
"courier_note":""
},
"products": [
{
"product_id":"1552",
"product_name":"Produkt 1",
"base_price": {
"net":45.37,
"gross":55.81,
"vat":10.44
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER"
}
},
{
"product_id":"1551",
"product_name":"Produkt 2",
"base_price": {
"net":90.26,
"gross":111.02,
"vat":20.76
},
"quantity": {
"quantity":1,
"quantity_type":"INTEGER"
}
}
],
"consents": [
{
"consent_id":"Polityka prywatności",
"consent_version":"1678260494",
"is_accepted":true
},
{
"consent_id":"Regulamin",
"consent_version":"1678260494",
"is_accepted":true
}
]
}