Updating orders at the Merchant's
The method intended to transfer the update data for an order to the Merchant.
POST /v1/izi/order/{order_id}/event
Parameters
Field name | Description | Type | Requirement status | Additional remarks |
| Order's unique ID assigned by the Merchant | string | Y |
|
Request
Field name | Description | Type | Requirement status | Additional remarks |
| Event's ID | string | Y |
|
| Event's date | string($date-time) | Y |
|
| Object with the user's phone number | object | O |
|
| Prefix | string | Y |
|
| Telephone number | string | Y | |
| Object with the event's data | object | Y |
|
| Payment status | string | O |
|
| Order's status | string | O | |
| Payment's ID | string | O | |
| Payment's references | string | O | |
| 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 |
Response
Field name | Description | Type | Requirement status | Additional remarks |
| Technical status - used to specify the authorizations that the customer may exercise for the order in the InPost Pay app. The merchant may provide two statuses: We can distinguish 3 technical statuses:
| string | O |
|
| 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 |
|
| Object intended to transfer the list of reference numbers of the shipments dispatched | array | O |
|
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"
}
}