API Requests

Checking-in a customer at service point

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

Get List of Active Check-Ins

GET https://<base-URL>/partner/api/place/{placeId}/checkins

Partner host requests the Cardsmobile host for a list of check-ins that are active for this service point at this time and returns the list to a cash desk software screen.

Path Parameters

Name	Type	Description
placeId*	string	Service point ID

Headers

Name	Type	Description
offerId*	string	ID of a loyalty program in the Cardsmobile platform

200: OK The request is processed. The response body contains a list of currently active check-ins and corresponding loyalty cards:

[
 {
   "secretCode": "5533",
   "checkinNumber": 1024,
   "cardNumber": "000000111001"
 }, 
 {
   "secretCode": "8387",
   "checkinNumber": 1025,
   "cardNumber": "000000111002"
 }, 
 {
   "secretCode": "0022",
   "checkinNumber": 1026,
   "cardNumber": "000000111003"
 } 
]

422: Unprocessable Entity An error occurred. The response body contains a description of the error occurred:

{
   "error": {
      "gsonDiscriminator": "ru.cardsmobile.checkin.sp.partner.ObjectNotFountException",
      "code": "ObjectNotFountException",
      "detailMessage": "Place not found",
      "clientMessage": "Place not found",
      "reason": "ObjectNotFountException"
   }
}

Response parameters:

Parameter	Type	Mandatory	Description
secretCode	String	Yes	Secret code of check-in (4 digits)
checkinNumber	String	Yes	ID of check-in
cardNumber	String	Yes	Loyalty card number in partner's CRM system

Register Used Check-In

POST https://<base-URL>/partner/api/checkin/register

Request to cancel (deactivate) an active check-in.

Headers

Name	Type	Description
offerId*	string	ID of a loyalty program in the Cardsmobile platform

Request Body

Name	Type	Description
checkinNumber*	string	ID of check-in

200: OK The request is processed. The response body is empty:

422: Unprocessable Entity An error occurred. The response body contains a description of the error occurred:

{
   "error": {
      "gsonDiscriminator": "ru.cardsmobile.checkin.sp.partner.ObjectNotFountException",
      "code": "ObjectNotFountException",
      "detailMessage": "Place not found",
      "clientMessage": "Place not found",
      "reason": "ObjectNotFountException"
   }
}

When the loyalty card (that is checked in) has been applied to the customer's order, the cash desk software must initiate the check-in deactivation process. The corresponding request must be sent to the Cardsmobile host.

Example of request body:

{"checkinNumber": 1025}

After deactivation, the canceled check-in will not be in the list of active check-ins returned in the answer to the Get List of Active Check-Ins request. To make the next purchase (order) with the loyalty card, the customer will need to get a new check-in.