POST Callback-URL

Нотификации об изменении статуса заказа.

Формат запроса

POST Callback-URL

Callback-URL — url из настроек интеграции.

Формат тела запроса


   {
     "eventType": "string",
     "orderId": "string",
     "orderStatus": "string",
     "paymentLink": "string",
     "timestamp": "string",
     "error": "string",
   }

`eventType`*	Событие. Допустимые значения: `ORDER_NEW` – заказ сохранен, в процессе создания; `ORDER_CREATED` – заказ создан, получена ссылка на оплату; `ORDER_PAID` – заказ оплачен; `ORDER_REFUNDED` – поступил возврат по заказу; `ORDER_CANCELED` – заказ был отменен; `ORDER_UPDATED` – изменен состав заказа; `ORDER_FAILED` – заказ закрыт с ошибкой.
`orderId`*	Номер заказа, идентификатор в системе.
`orderStatus`*	Статус заказа. Допустимые значения: `NEW` – новый; `CREATED` – получена ссылка на оплату; `PAID` – оплачен; `REFUNDED` – возврат; `CANCELED` – отменен; `FAILED` – ошибка.
`paymentLink`	Cсылка на оплату заказа.
`timestamp`*	Время события.
`error`	Ошибка.

* Обязательный параметр

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

{
    "status": {string}
}

status

Статус запроса.

Допустимые значения:

SUCCESS — успешный запрос;
ERROR — ошибка.

Коды ответа

Код	Причина	Описание
200	OK	Успешный запрос.
400	BAD_REQUEST	Синтаксическая ошибка в запросе.
500	INTERNAL SERVER ERROR	Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X POST 'https://apiauto.ru/1.0/Callback-URL
   
   {
     "eventType": "ORDER_CREATED",
     "orderId": "12345",
     "orderStatus": "CREATED",
     "paymentLink": "string",
     "timestamp": "15:18:43",
     "error": "string",
   }

Ответ:

HTTP/1.1 200 OK
     Server: nginx
     Date: Fri, 1 Mar 2024 15:19:41 GMT
     Content-Type: application/json
     Connection: keep-alive
     
   {
     "status": "SUCCESS"
   }

Была ли статья полезна?

PUT split/order

POST split/order/refund