---
title: "Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › attendee

`POST /v1/stores/{store}/products/{product}/attendees/check_in`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `attendee:checkin`

## Path parameters

- `store` (`checkInEventAttendee.path.store`; string, required) — The store's id.
- `product` (`checkInEventAttendee.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Header parameters

- `Idempotency-Key` (`checkInEventAttendee.header.Idempotency-Key`; string, optional) — Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.
  - minLength 1; maxLength 255; pattern `^[\x21-\x7E]+$`

## Request body

_Required._

- `session` (`checkInEventAttendee.session`; object, required) — The session they are let in at.
  - `id` (`checkInEventAttendee.session.id`; string, required)
    - minLength 1; maxLength 512
- `ticket_code` (`checkInEventAttendee.ticket_code`; string, optional) — The code their ticket's QR code holds, as scanned or typed; give this or `attendee`.
  - minLength 1; maxLength 64
- `attendee` (`checkInEventAttendee.attendee`; object, optional) — The attendee, as the guest list names them; give this or `ticket_code`.
  - `id` (`checkInEventAttendee.attendee.id`; string, required)
    - minLength 1; maxLength 512

## Example request

```json
{
  "session": {
    "id": "string"
  },
  "ticket_code": "string",
  "attendee": {
    "id": "string"
  }
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees/check_in' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session": {
    "id": "string"
  },
  "ticket_code": "string",
  "attendee": {
    "id": "string"
  }
}
'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees/check_in';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({session: {id: 'string'}, ticket_code: 'string', attendee: {id: 'string'}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees/check_in"

payload = {
    "session": { "id": "string" },
    "ticket_code": "string",
    "attendee": { "id": "string" }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.

#### Example

```json
{
  "checked_in": 0,
  "going": 0,
  "result": "string",
  "attendee": {
    "id": "string",
    "status": "string",
    "cancel_reason": "string",
    "tier": {
      "id": "string",
      "name": "string",
      "rank": 0
    },
    "customer": {
      "id": "string",
      "name": "string",
      "email": "string",
      "erased": true
    }
  },
  "check_in": {
    "id": "string",
    "session_id": "string",
    "checked_in_at": "string",
    "checked_in_by": "string",
    "token_id": "string"
  }
}
```

- `checked_in` (`checkInEventAttendee.response.200.checked_in`; number, required)
- `going` (`checkInEventAttendee.response.200.going`; number, required)
- `result` (`checkInEventAttendee.response.200.result`; string, required) — `checked_in` when this call let them in, `already_checked_in` when an earlier one had, `not_going` when they hold no ticket to it, no more or not yet.
- `attendee` (`checkInEventAttendee.response.200.attendee`; object, required)
  - `id` (`checkInEventAttendee.response.200.attendee.id`; string, required)
  - `status` (`checkInEventAttendee.response.200.attendee.status`; string, required) — `going` while a grant holds, `pending` or `waitlisted` while their request waits, `canceled` once none does.
  - `cancel_reason` (`checkInEventAttendee.response.200.attendee.cancel_reason`; any of, required) — Why they no longer hold the event: `refunded`, `revoked`, `expired`, `declined`, or `canceled` when the seller canceled it; null unless canceled.
    - any of: `string`, `null`
  - `tier` (`checkInEventAttendee.response.200.attendee.tier`; any of, required) — Their ticket type; null for access with no tier.
    - any of: `object`, `null`
  - `customer` (`checkInEventAttendee.response.200.attendee.customer`; any of, required)
    - any of: `object`, `null`
- `check_in` (`checkInEventAttendee.response.200.check_in`; any of, required) — Their check-in at the session; null while they have none.
  - any of: `object`, `null`

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`checkInEventAttendee.response.default.type`; string, required)
  - format `uri`
- `title` (`checkInEventAttendee.response.default.title`; string, required)
- `status` (`checkInEventAttendee.response.default.status`; integer, required)
- `detail` (`checkInEventAttendee.response.default.detail`; string, required)
- `code` (`checkInEventAttendee.response.default.code`; string, optional)
- `context` (`checkInEventAttendee.response.default.context`; object, optional)
- `reached_core` (`checkInEventAttendee.response.default.reached_core`; boolean, optional)
- `core_answer` (`checkInEventAttendee.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/check-in-event-attendee/index.md
