Create a loyalty checkin for the given location.
POST ~/loyalty/checkins
Headers
| Field | Type | Description |
|---|---|---|
| doshii-location-id | String | The hashed ID of the location you're targeting. See Hashed Location IDs |
Parameters
| Field | Type | Description |
|---|---|---|
| member | Object |
An object referring to the loyalty member that has arrived at the venue. |
| ref | String |
The reference name or number associated with the loyalty member for this loyalty checkin |
| nameoptional | String |
The name of the loyalty member |
| imageUrioptional | Uri |
A URI referencing an external image that can be accessed by POS for the purposes of identifying a loyalty member. |
| rewardsoptional | Object |
An object containing a list of rewards this loyalty member is eligible to receive |
| itemsoptional | Object[] |
A list of items that could be applied to an order for this loyalty member |
| rewardRefoptional | String |
A reference to the reward within the Loyalty system |
| <order items> | ... |
The standard order item information described in the Add Order Items endpoint. |
| surcountsoptional | Object[] |
A list of surcounts that the loyalty member is eligible to receive |
| rewardRefoptional | String |
A reference to the reward within the Loyalty system |
| name | String |
The name of the surcount, to be displayed in the POS |
| type | String |
Whether this is an 'absolute' or 'percentage' Surcount reward. |
| amount | Number |
The amount to surcharge/discount (positive/negative integer). |
| posIdoptional | String |
The ID of the surcount in the POS |
| valueoptional | Number | The value of the surcounts in cents. Accepts integer or string of integers. This value should only be provided if the surcount is absolute. |
| descriptionoptional | String | Description of the reward |
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 |
| 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
Request
{
"member": {
"ref": "123-456-789",
"name": "Joe Bloggs",
"imageUri": "https://image.somewhere.else/member/123-456-789.png"
}
}Response
{
"id": 27,
"locationId": "B31GBZYme",
"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.