Articles in this section

Get Loyalty Checkin

Avatar
John Twomey
  • Updated
Follow

Retrieve a single loyalty checkin associated to this location with the given ID.

GET ~/loyalty/checkins/:id

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard

Parameters

Field Type Description
:id String The ID of the Loyalty Checkin that you are looking to retrieve.

 Response

Field Type Description
id Number A Doshii generated ID referencing the loyalty checkin.
locationId String A hashed location ID that refers to the location the checkin is associated to. See Hashed Location IDs
appId String The ID of the Loyalty App that created the loyalty checkin.
member Object

An object referring to the loyalty member that has arrived at the venue.
  name String

The name of the loyalty member
  ref String

The reference name or number associated with the loyalty member for this loyalty checkin
  imageUri Uri

A URI referencing an external image that can be accessed by POS for the purposes of identifying a loyalty member.
updatedAt Date

Date when the loyalty checkin was last updated
createdAt Date

Date when the loyalty checkin was created
uri String

URI of the loyalty checkin within Doshii

Example

Response

{
   "id": 27,
   "locationId": "B31GBZYme",
   "appId": 175,
   "member": {
      "ref": "123-456-789",
      "name": "Joe Bloggs",
      "imageUri": "https://image.somewhere.else/member/123-456-789.png"
   },
   "createdAt": "2019-07-10T05:02:49.626Z",
   "updatedAt": "2019-07-10T05:02:49.626Z",
   "uri": "https://sandbox.doshii.co/pos/v3/loyalty/checkins/27"
}

Comments

0 comments

Please sign in to leave a comment.