Aktualizacja zamówienia u Merchanta

Metoda służąca do przekazania informacji o aktualizacji danych na zamówieniu do Merchanta.

W danej metodzie wymagamy implementacji wszystkich pól wymienionych w tabeli, ponieważ składają się na całość usługi InPost Pay. Część poniższych pól w kolumnie 'Wymagalność' jest oznaczona jako 'O' tj. opcjonalna ze względu na to, że nie wszystkie produkty/koszyki w sklepach internetowych mają przypisane wszystkie parametry, więc koszyk może zostać utworzony, a zamówienie złożone bez nich. Jednak implementacja/wdrożenie wszystkich pól jest biznesowo WYMAGANE.

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	Y

Request

Nazwa pola	Opis	Typ	Wymagalność	Dodatkowe uwagi
`event_id`	Id eventu	string	Y	`"event_id":"81af00fa-4913-4cd2-b05c-441b2d8df885"`
`event_data_time`	Data eventu	string($date-time)	Y	`"event_data_time":"2023-09-20T13:27:25.760Z"`
`phone_number`	Obiekt z numerem telefonu użytkownika	object	O
`phone_number.country_prefix`	Prefix	string	Y	`"phone_number":{"country_prefix":"+48","phone":"200000000"}`
`phone_number.phone`	Numer telefonu	string	Y
`event_data`	Obiekt z danymi eventu	object	Y
`event_data.payment_status`	Status płatności	string	O	`"event_data":{"payment_status":"AUTHORIZED","payment_id":"6e374060...","payment_reference":"53877...","payment_type":"BLIK_CODE"}`
`event_data.order_status`	Status zamówienia	string	O
`event_data.payment_id`	Id płatności	string	O
`event_data.payment_reference`	Referencje płatności	string	O
`event_data.payment_type`	Typ płatności 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

Nazwa pola

Opis

Typ

Wymagalność

Dodatkowe uwagi

order_merchant_status_description

Status opisowy prezentowany klientowi w aplikacji InPost Pay - każdy Merchant może nazywać status według własnego procesu tak, aby statusy prezentowane w InPost Mobile były zgodne ze statusem z platformy Merchanta.

string

O

Example:

"order_merchant_status_description":"W trakcie realizacji"

delivery_references_list

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

array

O

Example:

"delivery_references_list":["12345678"]

Przykładowy 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"
  }
}

Developer Documentations

Aktualizacja zamówienia u Merchanta

Related pages