POST /checkins
Add a checkin to the system(when the member scans / checks in to the club) to Club OS. Checkins are displayed on the members profile page and used in reporting.
POST https://api.club-os.com/clubservicescheckins?clubLocationId=[clubLocationId]
Parameters
The following fields must be included as parameters in the URL of the request.
| Variable | Type | Description |
|---|---|---|
| clubLocationId | Integer | The Club OS unique id for the club location you wish to access. Club OS will provide these to you. |
Request Body
The following fields must be included in the body of the HTTP request as a valid JSON string.
| Property | Type | Required | Default | Description | |
|---|---|---|---|---|---|
| memberId | Integer | Y | The Club OS unique id for the member who bought the club servicechecked in. | ||
| salespersonId | Integer | Y | The Club OS unique id for the salesperson who was responsible for selling the club service. | ||
| localServiceId | localCheckinId | String | Y | Your systems unique id for the club service. | |
| name | String | Y | The name of the service - as of now, 'Personal Training' is the only option. | ||
| qty | Decimal | Y | The qty of sessions purchased. | ||
| unitPrice | Decimal | Y | The unit price (cost of 1 item) of the service. | ||
| taxes | Decimal | N | The amount of taxes on the payment. | ||
| autoRenew | Boolean | Y | false | true - the club service auto-renews. false - the club service does not auto-renew. | |
| startDate | checkin. | ||||
| checkinTime | Date (M-d-YYYY HH:mm:ss) | Y | The effective start date and time of the club service. | ||
| endDate | Date (M-d-YYYY) | N | The end date of the club service if one exists. | ||
| saleDate | Date (M-d-YYYY) | Y | The date of the sale. | ||
| paidOnSale | Decimal | Y | The amount paid on the saleDate, or the date the club service was purchased. | ||
| recurType | String | N | monthly | One of 'monthly' or 'weekly'checkin. HH should be in military time i.e. 00-23. |
Response Messages
One of the following messages will be returned when the request succeeds.
| Message | Description | |
| Club Service Check-in Created | Club Service Checkin successfully created. | Club Service Updated |
| Club Service successfully updatedCheck-in Found | Checkin already exists in the system with the given localCheckinId. |