v1

latestOpenAPI 3.0.02026-07-1411021.7 KB

Уведомление о событии

Запрос делается: с сервера MAXMA на ваш сервер. URL для вызова может быть любым.

Вызывается, когда происходит событие, на которое вы подписаны. Содержит код произошедшего события и его атрибуты.

post/your-path

Request body

eventstring required

Код произошедшего события.

Коды событий и рсшифровки приведены в таблице "События".

eventIdstring required

Уникальный идентификатор события.

Можно использовать для того, чтобы игнорировать ранее обработанное, но повторно полученное событие.

eventTimestring date-time required

Дата и время произошедшего события

source'api' | 'internal' required

Источник изменения.

Возможные значения:

api - изменение сделано извне по API;
internal - изменение произошло внутри системы.

Example request

[
  {
    "event": "EVENT_CLIENT_EMAIL_UNSUBSCRIBED",
    "eventId": "3f94c77c-5e2a-4a6e-85cd-730d0c7b33aa",
    "eventTime": "2016-12-19T16:39:57+03:00",
    "EVENT_CLIENT_EMAIL_UNSUBSCRIBED": {
      "client": {
        "phoneNumber": "+79991234567",
        "card": "200000000446"
      },
      "email": "zhiglov20@gmail.com"
    }
  },
  {
    "event": "EVENT_CLIENT_CHANGED",
    "eventId": "0a353b66-5ac9-4cbb-9c52-596f46bfac62",
    "eventTime": "2016-12-19T17:24:32+03:00",
    "EVENT_CLIENT_CHANGED": {
      "client": {
        "phoneNumber": "+79991234567",
        "card": "200000000446"
      },
      "clientData": {
        "phoneNumber": "+79991234567",
        "card": "200000000447",
        "email": "zhiglov20@gmail.com",
        "surname": "Жиглов",
        "name": "Вениамин",
        "patronymicName": "Карлович",
        "fullName": "Вениамин Карлович Жиглов",
        "gender": 1,
        "birthdate": "1967-11-21T00:00:00+03:00",
        "city": "Реутов",
        "street": "Победы"
      }
    }
  },
  {
    "event": "EVENT_CLIENT_BONUSES_CHANGED",
    "eventId": "00f09507-2aea-4bc4-aad9-c68e83a8448c",
    "eventTime": "2016-12-19T17:24:44+03:00",
    "EVENT_CLIENT_BONUSES_CHANGED": {
      "client": {
        "phoneNumber": "+79991234567",
        "card": "200000000447"
      },
      "clientBonuses": {
        "totalAmount": 800,
        "availableAmount": 600,
        "pendingAmount": 200
      },
      "bonusesDelta": {
        "availableDelta": -100,
        "pendingDelta": 0
      }
    }
  },
  {
    "event": "EVENT_PURCHASE_NEW",
    "eventId": "0a353b66-5ac9-4cbb-9c52-596f46bfac62",
    "eventTime": "2016-12-19T17:24:32+03:00",
    "EVENT_PURCHASE_NEW": {
      "client": {
        "phoneNumber": "+79991234567",
        "card": "200000000447"
      },
      "shop": {
        "code": "1",
        "name": "Магазин 1"
      },
      "cashier": {
        "code": "1",
        "name": "Кассир 1"
      },
      "txid": "00f09507-2aea-4bc4-aad9-c68e83a8448c",
      "executedAt": "2016-12-19T17:24:32+03:00",
      "totalAmount": 1000,
      "totalDiscount": 200,
      "discounts": {
        "initial": 0,
        "bonuses": 200,
        "promocode": 0,
        "offer": 0,
        "rounding": 0
      },
      "bonuses": {
        "applied": 200,
        "collected": 120
      }
    }
  }
]

Response

Запрос обработан успешно

All 1 operations