Fetching order details

Field name

Description

Type

Requirement status

Additional remarks

order_id

Order's unique ID assigned by the Merchant

string

Y

Field name

Description

Type

Requirement status

Additional remarks

order_details

Order details

object

Y

order_details.order_comments

Comments about the order

string

O

"comments":"Order is being processed"

order_details.order_id

Order ID assigned by the Merchant

string

Y

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

order_details.customer_order_id

Order ID presented to the customer and used for payment. If missing, the order_id is used

string

O

"customer_order_id":"3433d1b7”

order_details.pos_id

POS id

string

Y

"pos_id":"V000000000"

order_details.order_creation_date

Date when the order was created

string($date-time)

Y

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

order_details.basket_id

Basket ID on the basis of which the order was created

string

Y

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

order_details.payment_type

Selected payment method. 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

Descriptive status presented to the customer in the InPost Pay app - each Merchant can transfer the status so that the statuses presented in InPost Mobile are consistent with the statuses presented to the customer in the Merchant's store.

string

Y

"order_merchant_status_description":"In progress"

order_details.order_base_price

Price for the order excluding 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

Price per order including 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.order_discount

Value of discount codes applied to the order

number($decimal) 

Y 

"order_discount": 20.2

order_details.currency

Order currency (currently only PLN)

string

Y

"currency":"PLN"

order_details.delivery_references_list

List of assigned order shipment numbers

array

O

"delivery_references_list":[12345678]

order_details. order_additional_parameters

An object used to pass additional order parameters that are saved in order details. Merchant can use the object, for example, to save parameters that will allow to identify/link the order to the campaign. The additional parameters are not presented in the application.

array

O

order_details. order_additional_parameters.key

Key

string

Y

order_details. order_additional_parameters.value

Value

string

Y

account_info

User account information

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

Phone number

object

Y

account_info.phone_number.country_prefix

Prefix

string

Y

account_info.phone_number.phone

User phone number

string

Y

account_info.mail

E-mail address of the InPost Pay application user. Merchant can use the above e-mail address only for the purposes of setting up a customer account, user verification, etc. If the user logs in to InPost Pay using Apple, the account's email address contains the hash assigned by Apple and is passed in the following form: abc@privaterelay.appleid.com, for example. In order for a Merchant to communicate with a customer using this address, the Merchant's domain must be added to the InPost account in Apple. Apple limits the number of domains that may be assigned to an account to 100. Therefore, InPost forwards the e-mail address abc@mail.inpostpay.pl to Merchant with the same hash, but in the domain mail.inpostpay.pl.

string

Y

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

account_info.client_address

User 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 details

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 ID

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

invoice_details.street

Street name

string

O

invoice_details.building

Building number

string

O

invoice_details.flat

Flat number

string

O

invoice_details.postal_code

Postal code

string

O

invoice_details.mail

E-mail

string

O

invoice_details.registration_data_edited

Registration date

string

O

invoice_details.additional_information

Additional information

string

O

delivery

Delivery information

object

Y

delivery.delivery_type

Delivery option. Enum:[ APM, COURIER, DIGITAL ].  
APM - Automated Parcel Machine, COURIER - InPost courier service, DIGITAL - digital delivery

string

Y

"delivery_type":"COURIER"

delivery.delivery_date

Delivery date

string($date-time)

Y

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

delivery.delivery_options

Selected delivery options

array

O

delivery.delivery_options.delivery_name

Name

string

Y

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

delivery.delivery_options.delivery_code_value

Option code

string

Y

delivery.delivery_options.delivery_option_price

Amount of delivery option

object

Y

delivery.delivery_options.delivery_option_price.net

Net

number($decimal)

Y

delivery.delivery_options.delivery_option_price.gross

Gross

number($decimal)

Y

delivery.delivery_options.delivery_option_price.vat

VAT

number($decimal)

Y

delivery.mail

The masked e-mail address of the user in the order.inpostpay.pl domain, which the Merchant must mandatorily use to handle the created order, in particular registration/shipping (the parcel should be shipped to the e-mail from delivery.mail, which will enable its proper monitoring and to link the created order in InPost Pay with the parcel shipped for the order).

string

O

"mail":"...@order.inpostpay.pl"

delivery.digital_delivery_email

The e-mail address to which the digital product is to be sent. Passed only if there is a digital product in the basket. If the address contains a hash assigned by Apple and is in the form of abc@privaterelay.appleid.com, for example. In order for the Merchant to communicate with a customer using this address, the Merchant's domain must be added to the InPost account in Apple. Apple limits the number of domains that may be assigned to an account to 100. Therefore, InPost forwards the e-mail address abc@mail.inpostpay.pl to the Merchant with the same hash, but in the domain mail.inpostpay.pl.

string

O

"digital_delivery_email":"jankowalski@g...m"

delivery.phone_number

Phone number for delivery

object

O

delivery.phone_number.country_prefix

Prefix

string

Y

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

delivery.phone_number.phone

Phone number

string

Y

delivery.delivery_point

APM delivery point

string

O

"delivery_point":"RSL218"

delivery.delivery_address

Delivery address

object

O

delivery.delivery_address.name

Name

string

Y

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

delivery.delivery_address.country_code

Country code

string

Y

delivery.delivery_address.address

Address

string

Y

delivery.delivery_address.city

City

string

Y

delivery.delivery_address.postal_code

Postal code

string

Y

delivery.delivery_price

An object used to provide information about the cost of delivery

object

Y

delivery.delivery_price.net

Net price

number ($decimal)(10,2)

Y

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

delivery.delivery_price.gross

Gross price (net + VAT)

number ($decimal)(10,2)

Y

delivery.delivery_price.vat

VAT

number ($decimal)(10,2)

Y

delivery.courier_note

Notes for the courier

string

O

" courier_note ":"Please deliver the parcel after 4 p.m."

products

The list of products in the order

array

Y

products.product_id

Product ID assigned by the Merchant

string

Y

"product_id":26

products.product_category

Product category assigned by the Merchant

string

O

"product_category":20

products.product_type

A non-mandatory field specifying the product type. Assumes value:

·       PRODUCT – physical product

·       DIGITAL  – digital product.

If the value is null, then by default the application assumes that the product is physical.

string

O

"product_type":"DIGITAL"

products.ean

Ean

string

O

"ean":"0"

products.product_name

Product name

string

Y

"product_name":"Plecak washpapa"

products.product_description

Product description

string

O

"product_description":” \r\n\r\nDo you sometimes feel like dropping everything, packing and going to the Bieszczady Mountains? It’s a great vacation idea. And during the year, simply explore your city all over again.\r\n\r\nYou cannot go on a successful excursion without a sturdy backpack with a roll-up lid, sewn from high-quality materials, like the one we offer.\r\n\r\nCotton straps will ensure comfort, and washable sewing paper will express your attachment to nature. Remember! Behind every adventure is a good backpack."

products.product_link

Link to the product on the Merchant’s website

string

O

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

products.product_image

Link to product photo. Preferred formats: png, jpg (recommendation: png without background)

string

O

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

products.additional_product_images

An object used for providing additional product photos (list). The maximum number of photos is 10 (10 objects { "normal_size": "string", "small_size": "string" } )

object

O

-

products.additional_product_images.small_size

product photo. Preferred size 360 x 352

string

Y

-

products.additional_product_images.normal_size

product photo. Preferred size 360 x 504

string

Y

-

products.base_price

Product price including discounts and promotional codes applied to the product

object

Y

products.base_price.net

Net price

number ($decimal)(10,2)

Y

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

products.base_price.gross

Gross price (net + VAT)

number ($decimal)(10,2)