/
Downloading the details of an order

Downloading the details of an order

The method for downloading the details of an order through the InPost Pay app from the Merchant.

GET /v1/izi/order/{order_id}

Parameters

Field name

Description

Type

Requirement status

Additional remarks

order_id

Order's unique ID assigned by the Merchant

string

Y

 

 

Request – none

Response

Field name

Description

Type

Requirement status

Additional remarks

order_details

Order details

object

Y

 

order_details.order_comments

Comments to an order

string

O

"comments ": "Zamówienie przetwarzane"

order_details.order_id

An order ID assigned by the Merchant

string

Y

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

order_details.pos_id

POS id

string

Y

"pos_id":"V000000000"

order_details.order_creation_date

The date of creating an order

string($date-time)

Y

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

order_details.basket_id

The identifier of the basket, based on which the order has been created

string

Y

"basket_id":"f55646f7-5773-0009-d8ba-000064fae5e1"

order_details.payment_type

Selected payment type. 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"

order_details.order_merchant_status_description

A descriptive status presented to the customer in the InPost Pay app - each Merchant may provide the status so that the statuses presented in InPost Mobile are compliant with the status presented to the client in the merchant's store.

string

Y

"order_merchant_status_description": "W trakcie realizacji"

order_details.order_base_price

Order price without the delivery costs

object

Y

 

order_details.order_base_price.net

Net

number ($decimal)

Y

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

order_details.order_base_price.gross

Gross

number ($decimal)

Y

order_details.order_base_price.vat

VAT

number ($decimal)

Y

order_details.order_final_price

Order price with the delivery costs

object

Y

 

order_details.order_final_price.net

Net

number ($decimal)

Y

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

order_details.order_final_price.gross

Gross

number ($decimal)

Y

order_details.order_final_price.vat

VAT

number ($decimal)

Y

order_details.currency

Order's currency (currently, PLN only)

string

Y

"currency":"PLN"

order_details.delivery_references_list

List of the numbers assigned to an order's shipments

array

O

"delivery_references_list":[12345678]

account_info

Information about the account used

object

Y

 

account_info.name

First name

string

Y

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

account_info.surname

Last name

string

Y

account_info.phone_number

Telephone number

object

Y

account_info.phone_number.country_prefix

Prefix

string

Y

account_info.phone_number.phone

User's phone number

string

Y

account_info.mail

Mail

string

Y

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

account_info.client_address

User's address

object

Y

 

account_info.client_address.country_code

Country code

string

Y

"client_address":{"country_code":"PL","city":"TEST","address":"Ustronna 3/9 Ustronna 3 ","postal_code":"00-009"}

account_info.client_address.address

Address

string

Y

account_info.client_address.city

City

string

Y

account_info.client_address.postal_code

Postal code

string

Y

invoice_details

Invoice data

object

O

 

invoice_details.legal_form

Legal Form

Enum:[ PERSON, COMPANY ]

string

O

"invoice_details":{"legal_form":"COMPANY","country_code":"PL","tax_id":"0000000000","company_name":Test","city":"Warszawa","street":"ul. Krakowska","building":"10A","postal_code":"00-000","mail":"test@m..l","registration_data_edited":"true"}

invoice_details.country_code

Country code

string

O

invoice_details.tax_id_prefix

Id prefix

string

O

invoice_details.tax_id

tax identifier

string

O

invoice_details.company_name

Company name

string

O

invoice_details.name

First name

string

O

invoice_details.surname

Last name

string

O

invoice_details.city

City

string

O