Updating orders at the Merchant's

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

event_id

Event's ID

string

Y

"event_id":"81af00fa-4913-4cd2-b05c-441b2d8df885"

event_data_time

Event's date

string($date-time)

Y

"event_data_time":"2023-09-20T13:27:25.760Z"

phone_number

Object with the user's phone number

object

O

phone_number.country_prefix

Prefix

string

Y

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

phone_number.phone

Telephone number

string

Y

event_data

Object with the event's data

object

Y

event_data.payment_status

Payment status

string

O

"event_data":{"payment_status":"AUTHORIZED","payment_id":"6e374060...","payment_reference":"53877...","payment_type":"BLIK_CODE"}

event_data.order_status

Order's status

string

O

event_data.payment_id

Payment's ID

string

O

event_data.payment_reference

Payment's references

string

O

event_data.payment_type

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

O

Field name

Description

Type

Requirement status

Additional remarks

order_merchant_status_description

A descriptive status presented to the customer in the InPost Pay app - each merchant can name a status according to their own process, so that the statuses presented in InPost Mobile are compliant with the status on the Merchant's platform.

string

O

Example:

"order_merchant_status_description": "W trakcie realizacji"

delivery_references_list

Object intended to transfer the list of reference numbers of the shipments dispatched

array

O

Example:

"delivery_references_list":[12345678]