Pobranie listy zamówień

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

page_index 

Indeks stron 

string 

O 

page_size 

Rozmiar strony 

string 

O 

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

page_size

Rozmiar strony 

integer 

O 

"page_size":1

total_items

Całkowita liczba pozycji 

integer 

O 

"total_items":159

page_index

Indeks stron 

integer 

O 

"page_index":1

orders

Obiekt zwracający listę zamówień  

object 

O 

orders.order_details 

Szczegóły zamówienia 

object 

Y 

orders.order_details.order_comments

Uwagi o zmówieniu 

string 

O 

"comments ":"Zamówienie przetwarzane"

orders.order_details.order_id

Identyfikator zmówienia nadawany przez Merchanta 

string 

Y 

"order_id":"3433d1b7-fd9b-484b-aa68-80fccc575407"

orders.order_details.customer_order_id

Identyfikator zamówienia prezentowany klientowi oraz wykorzystywany do płatności. W przypadku braku wykorzystywany jest order_id.

string

O

"customer_order_id":"3433d1b7”

orders.order_details.pos_id

POS id 

string 

Y 

"pos_id":"000000000"

orders.order_details.order_creation_date 

Data utworzenia zamówienia 

string($date-time) 

Y 

"order_creation_date":"2023-09-07T14:18:41.949Z" 

orders.order_details.order_update_date 

Ostatnia data aktualizacji zamówienia 

string($date-time) 

O 

"order_update_date":"2023-09-07T14:23:54.190Z" 

orders.order_details.payment

Obiekt zwracający informacje o płatności 

object 

O 

orders.order_details.payment.payment_type

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 

"payment_type":"BLIK_CODE"

orders.order_details.payment.payment_status

Status płatności 

Enum:[ UNPAID, STARTED, PENDING, AUTHORIZED, DECLINED, CANCELLED, ERROR, COD ] 

string 

Y 

"payment_status":"AUTHORIZED"

orders.order_details.payment.available_payment_types

Dostępne typy płatności dla danego zamówienia.  

Lista z możliwymi wartościami : [ CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY ] 

array 

O 

"available_payment_types":["BLIK_CODE","BLIK_TOKEN","PAY_BY_LINK"]

orders.order_details.payment.payment_details

Szczegóły płatności 

object 

O 

orders.order_details.payment.payment_details.payment_reference

Numer referencyjny 

string 

Y 

"payment_reference":"52428_9b642ee3-ff3d-4fae-8ff8-30e29c0dafac" 

orders.order_details.payment.payment_details.payment_id 

Id płatność 

string 

O 

"payment_id":"3cb4967d-4b63-4c5c-84bc-54e699a2dca0" 

orders.order_details.payment.payment_details.payment_sec_token 

Wykorzystany token zabezpieczający  

string 

O 

"payment_sec_token":"eyJraWQiOiIyMDRjY2U0OC1iYTFkLTQ0ODYtOTNlNy1kY..." 

orders.order_details.payment.payment_details.payment.payment_type 

Typ płatności 

string 

Y 

"payment_type":"BLIK_TOKEN" 

orders.order_details.payment.payment_details.payment_token 

Token karty 

string 

O 

"payment_token":"gr...ki@it...om"

orders.order_details.payment.payment_details.payment_card 

Informacje o karcie 

object 

O 

orders.order_details.payment.payment_details.payment_card.last_four_digits 

Ostatnie 4 cyfry karty 

string 

O 

"last_four_digits":"0021"

orders.order_details.payment.payment_details.payment_card.scheme 

Schemat, w którym działa karta 

string 

O 

"scheme":"https://static.payu.com/images/mobile/logos/pbl_c.png" 

orders.order_details.payment.payment_details.payment_card.card_type 

Typ kart [ DEBIT, CREDIT, PREPAID, CHARGE, DEFERRED_DEBIT ] 

string 

O 

"card_type":" DEBIT"

orders.order_details.payment.payment_details.payment_status 

Status płatności 

string 

O 

"payment_status":"AUTHORIZED"

orders.order_details.payment.payment_details.payment_code 

Kod płatności 

string 

O 

"payment_code":"00"

orders.order_details.payment.payment_details.payment_description 

Dodatkowa informacja o płatności 

string 

O 

"payment_description":"APPROVED"

orders.order_details.payment.payment_details.payment_error_code 

Kod błędu 

string 

O 

"payment_error_code":"test" 

orders.order_details.payment.payment_details.payment_message_code 

Wiadomość o płatności (kod) 

string 

O 

"payment_message_code":"userCancelled" 

orders.order_details.payment.payment_details.payment_date 

Data transakcji 

string($date-time) 

O 

"payment_date":"2023-08-02T09:48:12.302Z" 

orders.order_details.order_status 

Status techniczny - służy do określenia uprawnień, jakie może wykonać klient na zamówieniu w aplikacji InPost Pay. 

Wyróżniamy 3 statusy techniczne: 

ORDER_COMPLETED - status nadawany przez Merchanta, informujący aplikacje InPost Pay, że zamówienie zostało sfinalizowane przez klienta na stronie sklepu Merchanta.

ORDER_REJECTED - status oznacza odrzucenie zamówienia. 

ORDER_PROCESSING - zamówienie w trakcie realizacji 

string 

Y 

"order_status":"ORDER_COMPLETED"

orders.order_details.order_merchant_status_description 

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 prezentowanymi klientowi w sklepie Merchanta. 

string 

Y 

"order_merchant_status_description":"W trakcie realizacji"

orders.order_details.order_base_price 

Cena za zamówienie bez kosztów dostawy 

object 

Y 

orders.order_details.order_base_price.net 

Netto 

number($decimal) 

Y 

"order_base_price":{"net":202.51,"gross":263.0,"vat":60.49},

orders.order_details.order_base_price.gross 

Brutto 

number($decimal) 

Y 

orders.order_details.order_base_price.vat 

VAT 

number($decimal) 

Y 

orders.order_details.order_final_price 

Cena za zamówienie z uwzględnieniem kosztów dostawy 

object 

Y 

orders.order_details.order_final_price.net 

Netto 

number($decimal) 

Y 

"order_final_price":{"net":208.2,"gross":270.0,"vat":61.8}

orders.order_details.order_final_price.gross 

Brutto 

number($decimal) 

Y 

orders.order_details.order_final_price.vat 

VAT 

number($decimal) 

Y 

orders.order_details.order_discount

Wartość zastosowanych kodów rabatowych na zamówieniu

number($decimal) 

Y 

"order_discount": 20.2

orders.order_details.currency 

Waluta zamówienia (obecnie tylko PLN) 

string 

Y 

"currency":"PLN"

orders.order_details.delivery_references_list 

Lista nadanych numerów przesyłek zamówienia 

array 

O 

"delivery_references_list":[12345678]

orders.account_info 

Informacje o koncie użytkowania 

object 

Y 

orders.account_info.name 

Imię  

string 

Y 

"account_info":{"name":"Jan","surname":"Kowalski","phone_number":{"country_prefix":"+48","phone":"600000000"}

orders.account_info.surname 

Nazwisko 

string 

Y 

orders.account_info.phone_number 

Numer telefonu 

object 

Y 

orders.account_info.phone_number.country_prefix 

Prefix 

string 

Y 

orders.account_info.phone_number.phone 

Numer telefonu użytkownika 

string 

Y 

orders.account_info.mail 

Mail 

string 

Y 

"mail":"test@g....m"

orders.account_info.client_address 

Adres użytkownika 

object 

Y 

orders.account_info.client_address.country_code 

Kod kraju 

string 

Y 

"client_address":{"country_code":"PL","city":"Test","address":"Testowa 3/9 Testowa 3 ","postal_code":"00-000"}

orders.account_info.client_address.address 

Adres 

string 

Y 

orders.account_info.client_address.city 

Miasto 

string 

Y 

orders.account_info.client_address.postal_code 

Kod pocztowy 

string 

Y 

orders.invoice_details 

Dane do faktury 

object 

O 

orders.invoice_details.legal_form 

Forma prawna [ PERSON, COMPANY ] 

string 

O 

"invoice_details":{"legal_form":"COMPANY","country_code":"PL","tax_id":"0000000000","company_name":TEST","city":"Warszawa","street":"ul. Testowa","building":"10A","postal_code":"01-997","mail":"test@m...l","registration_data_edited":"true"}

orders.invoice_details.country_code 

Kod kraju 

string 

O 

orders.invoice_details.tax_id_prefix 

Id prefix 

string 

O 

orders.invoice_details.tax_id 

Identyfikator podatkowy 

string 

O 

orders.invoice_details.company_name 

Nazwa firmy 

string 

O 

orders.invoice_details.name 

Imię 

string 

O 

orders.invoice_details.surname 

Nazwisko 

string 

O 

orders.invoice_details.city 

Miasto 

string 

O 

orders.invoice_details.street 

Ulica 

string 

O 

orders.invoice_details.building 

Numer budynku 

string 

O 

orders.invoice_details.flat 

Numer mieszkania 

string 

O 

orders.invoice_details.postal_code 

Kod pocztowy 

string 

O 

orders.invoice_details.mail 

Mail 

string 

O 

orders.invoice_details.registration_data_edited 

Data rejestracji 

string 

O 

orders.invoice_details.additional_information 

Dodatkowe informacje 

string 

O 

orders.delivery 

Informacje o dostawie 

object 

Y 

orders.delivery.delivery_type 

Forma dostawy Enum: 

[ APM, COURIER ] 

string 

Y 

"delivery_type":"COURIER"

orders.delivery.delivery_date 

Data dostawy  

string($date-time) 

Y 

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

orders.delivery.delivery_options 

Wybrane opcje dostawy 

array 

O 

orders.delivery.delivery_options.delivery_name 

Nazwa  

string 

Y 

"delivery_options":[{"delivery_name":"Paczka w Weekend","delivery_code_value":"PWW","delivery_option_price":{"net":5,"gross":"6.15","vat":"1.15"}}]

orders.delivery.delivery_options.delivery_code_value 

Kod opcji 

string 

Y 

orders.delivery.delivery_options.delivery_option_price 

Kwota opcji odstawy 

object 

Y 

orders.delivery.delivery_options.delivery_option_price.net 

Netto 

number($decimal) 

Y 

orders.delivery.delivery_options.delivery_option_price.gross 

Brutto 

number($decimal) 

Y 

orders.delivery.delivery_options.delivery_option_price.vat 

VAT 

number($decimal) 

Y 

orders.delivery.mail 

Mail 

string 

O 

"mail":"test@g..m" 

orders.delivery.phone_number 

Numer telefonu  

object 

O 

orders.delivery.phone_number.country_prefix 

Prefix 

string 

Y 

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

orders.delivery.phone_number.phone 

Numer  

string 

Y 

orders.delivery.delivery_point 

Punkt dostawy paczkomatu 

string 

O 

"delivery_point":"RSL218"

orders.delivery.delivery_address 

Adres dostawy 

object 

O 

orders.delivery.delivery_address.name 

Nazwa 

string 

Y 

"delivery_address":{"name":"Jan Kowalski","country_code":"PL","address":"Testowa 3 ","city":"Test","postal_code":"00-000"}

orders.delivery.delivery_address.country_code 

Kod kraju 

string 

Y 

orders.delivery.delivery_address.address 

Adres 

string 

Y 

orders.delivery.delivery_address.city 

Miasto 

string 

Y 

orders.delivery.delivery_address.postal_code 

Kod pocztowy 

string 

Y 

orders.delivery.delivery_price 

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

object 

Y 

orders.delivery.delivery_price.net 

Cena netto 

number ($decimal)(10,2) 

Y 

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

orders.delivery.delivery_price.gross 

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

orders.delivery.delivery_price.vat 

VAT 

number ($decimal)(10,2) 

Y 

orders.delivery.courier_note 

Uwagi dla kuriera 

string 

O 

" courier_note ":"Proszę o przekazanie przesyłki po godzinie 16"

orders.products 

Lista produktach w zamówieniu 

array 

Y 

orders.products.product_id 

Identyfikator produktu nadany przez Merchanta 

string 

Y 

"product_id":26

orders.products.product_category 

Kategoria produktu nadana przez Merchanta 

string 

O 

"product_category":20

orders.products.ean 

Ean 

string 

O 

"ean":"0"

orders.products.product_name 

Nazwa produktu  

string 

Y 

"product_name":"Plecak washpapa"

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

orders.products.product_link 

Link do produktu na stronie Merchanta 

string 

O 

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

orders.products.product_image 

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

string 

O 

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

orders.products.additional_product_images

Obiekt do przekazania dodatkowych zdjęć produktu (lista)

object

O

-

orders.products.additional_product_images.small_size

Zdjęcie produktu. Preferowany rozmiar 360 x 352

string

Y

-

orders.products.additional_product_images.normal_size

Zdjęcie produktu. Preferowany rozmiar 360 x 504

string

Y

-

orders.products.base_price 

Cena produktu uwzględniająca zastosowane rabaty i kody promocyjne na produkcie 

object 

Y 

orders.products.base_price.net 

Cena netto 

number ($decimal)(10,2) 

Y 

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

orders.products.base_price.gross 

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

orders.products.base_price.vat 

VAT 

number ($decimal)(10,2) 

Y 

orders.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 

object 

O 

orders.products.lowest_price.net 

Cena netto 

number ($decimal)(10,2) 

Y 

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

orders.products.lowest_price.gross 

Cena brutto (netto + VAT) 

number ($decimal)(10,2) 

Y 

orders.products.lowest_price.vat 

VAT 

number ($decimal)(10,2) 

Y 

orders.products.quantity 

Obiekt do przekazania informacji o ilości produktu 

object 

Y 

orders.products.quantity.quantity 

Ilość produktu 

number ($decimal) 

Y 

"quantity":1

orders.products.quantity.quantity_type 

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

string 

Y 

"quantity_type":"INTEGER"

orders.products.quantity.quantity_unit 

Jednostka ilości produktu 

string 

O 

"quantity_unit":"pcs"

orders.products.product_attributes 

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

array 

O 

orders.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"}]

orders.products.product_attributes.attribute_value

Wartość atrybutu 

string 

Y 

orders.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 

orders.products.variants.variant_id 

Id wariantu 

string 

Y 

orders.products.variants.variant_name 

Nazwa wariantu 

string 

Y 

orders.products.variants.variant_description 

Opis szczegółowy wariantu 

string 

O 

orders.products.variants.variant_type 

Typ wariantu 

string 

O 

orders.products.variants.variant_values 

Wartość wariantu 

string 

O 

orders.consents 

Obiekt służący do przekazania informacji o wyrażonych zgodach przez klienta dla danego zamówienia 

array 

Y 

orders.consents.consent_id 

Id zgody  

string 

Y 

"consent_id":3

orders.consents.consent_version 

Wersja zgody 

string 

O 

"consent_version":1

orders.consents.is_accepted 

Informacja czy została wyrażona zgoda 

boolean 

Y 

"is_accepted": true