Order update on the Merchant side

A method used to pass information about updated order data to the Merchant.

For this method, we require the implementation of all the fields listed in the table, as they make up the entirety of the InPost Pay service. Some of the following fields in the 'Required' column are marked as 'O', i.e. optional, due to the fact that not all products/baskets in online stores have all parameters assigned, so a basket can be created and an order placed without them. However, the implementation/deployment of all fields is REQUIRED from a business perspective.

POST /v1/izi/order/{order_id}/event

Parameters

Field name	Description	Type	Requirement status	Additional remarks
`order_id`	Order's unique ID assigned by the Merchant	string	Y

Request

Field name	Description	Type	Requirement status	Additional remarks
`event_id`	Event ID	string	Y	`"event_id":"81af00fa-4913-4cd2-b05c-441b2d8df885"`
`event_data_time`	Event ID	string($date-time)	Y	`"event_data_time":"2023-09-20T13:27:25.760Z"`
`phone_number`	An object containing the user’s phone number	object	O
`phone_number.country_prefix`	Prefix	string	Y	`"phone_number":{"country_prefix":"+48","phone":"200000000"}`
`phone_number.phone`	Phone number	string	Y
`event_data`	An object containing event 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 status	string	O
`event_data.payment_id`	Payment ID	string	O
`event_data.payment_reference`	Payment reference numbers	string	O
`event_data.payment_type`	Type of payment Enum: [ `CARD, CARD_TOKEN, GOOGLE_PAY, APPLE_PAY, BLIK_CODE, BLIK_TOKEN, PAY_BY_LINK, SHOPPING_LIMIT, DEFERRED_PAYMENT, CASH_ON_DELIVERY` ]	string	O

Response

Field name

Description

Type

Requirement status

Additional remarks

order_merchant_status_description

Descriptive status presented to the customer in the InPost Pay app – each Merchant can name the status in line with their own process, so that the statuses presented in InPost Mobile are consistent with the statuses from the Merchant’s platform.

string

O

Example:

"order_merchant_status_description": "W trakcie realizacji"

delivery_references_list

An object used to pass a list of reference numbers of dispatched shipments

array

O

Example:

"delivery_references_list":[12345678]

Example request

{
  "event_id": "c0660589-e9d6-4b84-bda8-8ad4fac8cf12",
  "event_data_time": "2023-12-17T08:56:43.819Z",
  "phone_number": {
    "country_prefix": "+48",
    "phone": "600000000"
  },
  "event_data": {
    "payment_status": "AUTHORIZED",
    "payment_id": "2ef680e4-d493-460d-a12e-93ecf7a50d15",
    "payment_reference": "56868_5d00723c-8f53-404b-a3f5-53077b1e18f6",
    "payment_type": "BLIK_CODE"
  }
}