Check-In API

M
M
Last updated 3 months ago

CardsMobile Check-In Service

get
Запрос списка активных чек-инов

/partner/api/place/{placeId}/checkins
Хост партнера запрашивает у CardsMobile список чек-инов, активных в данный момент, и возвращает актуальный список на экран кассового ПО.
Request
Response
Path Parameters
placeId
required
string
Идентификатор точки обслуживания, для которой выполняется запрос
Headers
offerId
required
string
Идентификатор программы лояльности партнера в системе CardsMobile
200: OK
Ответ содержит массив текущих активных чек-инов и соответствующих им карт лояльности:
[
{"secretCode": "5533", "checkinNumber": 1024, "cardNumber": "000000111001"},
{"secretCode": "8387", "checkinNumber": 1025, "cardNumber": "000000111002"},
{"secretCode": "0022", "checkinNumber": 1026, "cardNumber": "000000111003"}
]
422: Unprocessable Entity

Параметры ответа:

Параметр

Тип

Значение

secretCode

string

Секретный код чек-ина (4 цифры)

checkinNumber

string

Идентификатор чек-ина

cardNumber

string

Номер карты лояльности в информационной системе партнера

post
Регистрация использованного чек-ина

/partner/api/checkin/register
Запрос на погашение активного чек-ина.
Request
Response
Headers
offerId
required
string
Идентификатор программы лояльности партнера в системе CardsMobile
Body Parameters
checkinNumber
required
string
Идентификатор чек-ина
200: OK
В случае успеха хост CardsMobile вернет HTTP-код 200 с пустым телом ответа:
422: Unprocessable Entity

При добавлении к заказу карты лояльности, прошедшей чек-ин, кассовое ПО партнера должно инициировать деактивацию чек-ина; запрос на деактивацию должен быть передан на хост CardsMobile.

Пример тела запроса:

{"checkinNumber": 1025}

После деактивации чек-ин будет отсутствовать в списке, получаемом в ответ на Запрос списка активных чек-инов. Чтобы совершить очередную покупку (заказ) с картой лояльности, пользователю потребуется выполнить новый чек-ин.