Aktualizacja zamówienia

Metoda służy do aktualizacji informacji o zamówieniu w aplikacji InPost Pay (powiadomienia przekazywane do InPost Pay przez Merchanta o wystąpieniu zamiany na zamówieniu).

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

Parameters 

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

order_id 

Unikalny identyfikator zamówienia nadawany przez merchanta 

string 

  

 

Request  

Nazwa pola 

Opis  

Typ 

Wymagalność 

Dodatkowe uwagi 

event_id

Unikalny identyfikator eventu 

string 

"event_id":1694704936

event_data_time

Data wystąpienia zdarzenia 

string 

"event_data_time":"2023-09-14T15:22:16.000Z"

phone_number

Obiekt służący do przekazania numeru telefonu klienta 

object 

 

phone_number.country_prefix

Prefix 

string 

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

phone_number.phone

Numer telefonu klienta 

string 

event_data

Obiekt służący do przekazania danych eventu 

object 

 

event_data.order_status

Status techniczny - służy do określenia uprawnień, jakie może wykonać klient na zamówieniu w aplikacji InPost Pay. Merchant może przekazać dwa statusy:  

  

ORDER_COMPLETED - status nadawany przez Merchanta, informujący aplikacje InPost Pay, że zamówienie zostało sfinalizowane przez klienta na stronie sklepu Merchanta. Nie wysyłamy tego statusu dla zamówień, które zostały opłacone w aplikacji InPost.

ORDER_REJECTED - status oznacza odrzucenie zamówienia. 

string 

"order_status":"ORDER_COMPLETED"

event_data.order_merchant_status_description

Status opisowy prezentowany klientowi w aplikacji InPost Pay - każdy Merchant może przekazać status tak, aby statusy prezentowane w InPost Mobile były zgodne ze statusem prezentowanym klientowi w sklepie Merchanta. 

string 

"order_merchant_status_description":"W trakcie realizacji"

event_data.delivery_references_list

Obiekt służący do przekazania listy numerów referencyjnych nadanych przesyłek 

array 

"delivery_references_list":[12345678]

  

Response 

200 – aktualizacja danych zakończona sukcesem 

Przykładowy request 

{ "event_id": "xxxxxxxxxx", "event_data_time": "2023-08-23T09:26:45.000Z", "phone_number": { "country_prefix": "+48", "phone": "6xxxxxxxx" }, "event_data": { "order_status": "ORDER_COMPLETED", "order_merchant_status_description": "W trakcie realizacji", "delivery_references_list": [ "" ] } }