Creating an order

Field name

Description

Type

Requirement status

Additional remarks

order_details

The data for creating an order

object

Y

order_details.order_comments

Additional information about an order

string

O

"comments":"Zamówienie test"

order_details.basket_id

Identifier of the basket assigned by the Merchant based on which the order is to be created

string

Y

"basket_id":"4734da95-458b-44da-8d6e-854b2e501066"

order_details.currency

Currency. Currently, only PLN

string

Y

"currency":"PLN"

order_details.basket_price

The total estimated value of the basket along with the delivery costs

object

Y

order_details.basket_price.net

Net

number ($decimal)

Y

"basket_price":{"net":584.62,"gross":584.62,"vat":0}

order_details.basket_price.gross

Gross

number ($decimal)

Y

order_details.basket_price.vat

VAT

number ($decimal)

Y

order_details.payment_type

The payment form chosen by the user. Enum forms available:

[ 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":"PAY_BY_LINK"

account_info

Information about the account used

object

Y

account_info.name

First name

string

Y

"name":"Jan"

account_info.surname

Last name

string

Y

"surname":"Kowalski"

account_info.phone_number

Telephone number

object

Y

account_info.phone_number.country_prefix

Prefix

string

Y

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

account_info.phone_number.phone

User's phone number

string

Y

account_info.mail

Mail

If the user logs in to InPost Pay with the use of Apple, the e-mail address of the account includes the hash assigned by Apple, and has the form of, for instance, abc@privaterelay.appleid.com. For the Merchant to communicate with the customers using this address, the Merchant's domain must be added on the InPost account in Apple. Apple limits the number of domains assigned to an account down to 100. Hence, InPost transfers the e-mail address abc@mail.inpostpay.pl to the Merchant with the same hash, but in the mail.inpostpay.pl domain.

string

Y

"mail":"jan.nowak@t...l"

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":"POZNAN","address":"Testowa 100","postal_code":"00-000","address_details":{"street":"Testowa","building":"100"}}

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

account_info.client_address.address_details

An object for transferring an unparsed address

object

O

account_info.client_address.address_details.street

Street

string

O

account_info.client_address.address_details.building

Building number

string

O

account_info.client_address.address_details.flat

Apartment number

string

O

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

invoice_details.street

Street

string

O

invoice_details.building

Building number

string

O

invoice_details.flat

Apartment number

string

O

invoice_details.postal_code

Postal code

string

O

invoice_details.mail

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 method. Enum:

[ APM, COURIER ]

string

Y

"delivery_type":"APM"

delivery.delivery_codes

Selected delivery options - list

array

O

"delivery_codes":["PWW"]

delivery.mail

Mail

If the user logs in to InPost Pay with the use of Apple, the e-mail address of the account includes the hash assigned by Apple, and has the form of, for instance, abc@privaterelay.appleid.com. For the Merchant to communicate with the customers using this address, the Merchant's domain must be added on the InPost account in Apple. Apple limits the number of domains assigned to an account down to 100. Hence, InPost transfers the e-mail address abc@mail.inpostpay.pl to the Merchant with the same hash, but in the mail.inpostpay.pl domain.

string

O

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

delivery.phone_number

Telephone number

object

O

delivery.phone_number.country_prefix

Prefix

string

Y

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

delivery.phone_number.phone

Number

string

Y

delivery.delivery_point

Automatic parcel locker delivery site

string

O

"delivery_point":"RSL218"

delivery.delivery_address

Delivery address

object

O

delivery.delivery_address.name

Name

string

Y

"name":"Jan Kowalski"

delivery.delivery_address.country_code

Country code

string

O

"country_code":"PL"

delivery.delivery_address.address

Address

string

Y

"address":"SW.Jana 100"

delivery.delivery_address.city

City

string

Y

"city":"POZNAN"

delivery.delivery_address.postal_code

Postal code

string

Y

"postal_code":"11-005"

address_details

Unparsed address

object

O

address_details.street

Street

string

O

"address_details":{"street":"Swmichala","building":"100"}

address_details.building

Building number

string

O

address_details.flat

Premises number

string

O

delivery.courier_note

Notes for the courier

string

O

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

consents

An object intended to transfer information related to the consents expressed by the customer for a given order

array

Y

consents.consent_id

consent Id

string

Y

"consent_id":3

consents.consent_version

Consent version

string

O

"consent_version":1

consents.is_accepted

Info, whether or not the consent has been expressed

boolean

Y

"is_accepted": true

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

Order ID assigned by the Merchant

string

Y

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

order_details.customer_order_id

Order ID presented to customer and used for payment. In case of lack of customer_order_id order_id will be used.

string

O

"customer_order_id":"3433d1b7”

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

Value used discount coupons on order

number($decimal) 

Y 

"order_discount": 20.2

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":"Testowa 3/9 Testowa 3 ","postal_code":"11-111"}

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 [PERSON, COMPANY]

string

O

"invoice_details":{"legal_form":"COMPANY","country_code":"PL","tax_id":"0000000000","company_name":TEST","city":"Test","street":"ul. Krakowska","building":"10A","postal_code":"01-997","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

invoice_details.street

Street

string

O

invoice_details.building

Building number

string

O

invoice_details.flat

Apartment number

string

O

invoice_details.postal_code

Postal code

string

O

invoice_details.mail

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 method. Enum:

[ APM, COURIER ]

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

The options selected for a delivery

array

O

delivery.delivery_options.delivery_name

Name

string

Y

"delivery_options":[{"delivery_name":"Paczka w Weekend","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

Delivery option amount

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

Mail

string

O

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

delivery.phone_number

Telephone number

object

O

delivery.phone_number.country_prefix

Prefix

string

Y

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

delivery.phone_number.phone

Number

string

Y

delivery.delivery_point

Automatic parcel locker delivery site

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":"Testowana 3 ","city":"test","postal_code":"09-100"}

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

Object intended to transfer information related to 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 ":"Proszę o przekazanie przesyłki po godzinie 16"

products

List of the products in an 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.ean

Ean

string

O

"ean":"0"

products.product_name

Product name

string

Y

"product_name": "washpapa backpack"

products.product_description

Product description

string

O

"product_description": "  \r\n\r\nSometimes you just want to leave everything, pack your bags and go to Bieszczady? It's a good plan for holidays. And during the year, simply discover your city again.\r\n\r\ Exploration cannot be successful without a reliable backpack with foldable closings and made of high quality materials, such as our.\r\n\r\nThe cotton straps ensure the convenience of carrying, and washpapa will express your devotion to the nature. Remember! Behind each adventure, there 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 a photograph of the product. Formats preferable: 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

Additional product images.

object

O

-

products.additional_product_images.small_size

Product image. Preferred size 360 x 352

string

Y

-

products.additional_product_images.normal_size

Product image. Preferred size 360 x 504

string

Y

-

products.base_price

Product's base price

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)

Y

products.base_price.vat

VAT

number ($decimal) (10,2)

Y

products.quantity

Object for reporting the product quantity

object

Y

products.quantity.quantity

product quantity

number ($decimal)

Y

"quantity":1

products.quantity.quantity_type

Field type quantity. Available values: Enum: [DECIMAL, INTEGER]

If the quantity_type of the product is INTEGER, then the Merchant provides the price for 1 piece. If the quantity_type of the product is DECIMAL, then the Merchant provides the price for the product quantity selected.

·       Example 1) We have 5 pcs of shirts 10 PLN a piece. In such a case, the quantity_type, is INTEGER and the product's price is PLN 10.

·       Example 2) We have 0.35 kg of flour, costing PLN 5. In such a case, the quantity_type, is DECIMAL and the product's price is PLN 5.

string

0

"quantity_type":"INTEGER"

products.quantity.quantity_unit

Quantity unit of the product

string

O

"quantity_unit":"pcs"

products.product_attributes

Object intended to determine the product's attributes

array

O

products.product_attributes.attribute_name

Attribute name

string

Y

"product_attributes ": [{ "attribute_name ": "Dimensions/Capacity", "attribute_value ":"54 cm x 38 cm x 10 cm "}, { "attribute_name ": "Material", "attribute_value": "Washable paper standard + kodura + woven cotton straps"}]

products.product_attributes.attribute_value

Attribute value

string

Y

products.variants

Object intended to transfer products' variants. Object currently not used. The functionality shall be implemented in the app's subsequent versions.

object

O

products.variants.variant_id

Version's Id

string

Y

products.variants.variant_name

Version's name

string

Y

products.variants.variant_description

Version's detailed description

string

O

products.variants.variant_type

Version's type

string

O

products.variants.variant_values

Version's value

string

O

consents

An object intended to transfer information related to the consents expressed by the customer for a given order

array

Y

consent_id

consent Id

string

Y

"consent_id":3

consents.consent_version

Consent version

string

Y

"consent_version":1

consents.is_accepted

Info, whether or not the consent has been expressed

boolean

Y

"is_accepted": true