Sign in

v11

latestOpenAPI 3.1.12026-08-03174162.0 MB
Tickets

Check out tickets by key

put/tickets/{key}/check-out

Path parameters

keystring required

Transition key. Supports canonical ticket IDs (tkt_) and order IDs (ord_).

Example:tkt_01jps5cgsg0s32w2pr73vbccde

Request body

eventIdstring

Optional event scope guard for check-in transitions. When provided, check-in fails if the ticket/order event does not match.

deviceIdstring

Unique identifier of the scanning device (optional).

allowPartialOrderCheckInboolean

Confirms an order-level check-in when some tickets are already redeemed and some remain active.

admissionIdsstring[]

Optional scanner admission filters. When provided, check-in only applies to matching ticket admissions.

sectionIdsstring[]

Optional scanner section filters. When provided, check-in only applies to matching ticket sections.

idempotencyKeystring

Stable client-generated key used to replay a scan request without turning a timed-out success into a duplicate denial.

Response

OK

targetType'ticket' | 'order' required

Resolved target scope from the provided key.

Example response

{
  "tickets": [
    {
      "id": "tkt_01jps5cgsg0s32w2pr73vbccde",
      "createdAt": "2026-08-03T06:13:52.220Z",
      "updatedAt": "2026-08-03T06:13:52.220Z",
      "scans": [
        {
          "id": "scn_01jq4rjmtzyzgtsavn9f34mxan",
          "scannedAt": "2026-08-03T06:13:52.219Z",
          "scannedById": "usr_01jps5cgsd4tzjghtnt45qnhn0",
          "scannedBy": {
            "id": "usr_01jps5cgsd4tzjghtnt45qnhn0",
            "firstName": "Jay",
            "lastName": "McMullen",
            "email": "test@session.services"
          },
          "deviceId": "dev_01jq4rjvrgar43zwvyakbje22m",
          "kind": "CHECK_IN"
        }
      ],
      "status": "ACTIVE",
      "attendee": {
        "firstName": "Test",
        "lastName": "User",
        "email": "test@session.services",
        "phone": "+61411111111"
      },
      "customerId": "cus_01jps5cgsf4pn2a32eamppnap1",
      "eventId": "evt_01jps5cgsenjrazw6wswmyspa3",
      "event": {
        "id": "evt_01jps5cgsenjrazw6wswmyspa3",
        "name": "Test Event",
        "slug": "test-event",
        "location": {
          "id": "loc_01hk153x00eh99pagyydz03sbz",
          "googlePlaceId": "ChIJP3Sa8ziYEmsRUKgyFmh9AQM",
          "createdAt": "2026-08-03T06:13:52.214Z",
          "updatedAt": "2026-08-03T06:13:52.214Z",
          "name": "Watson's EQ",
          "address": "The, Entertainment Quarter, 1 Bent St, Moore Park NSW 2021, Australia",
          "city": "Moore Park",
          "state": "New South Wales",
          "postcode": "2021",
          "country": "Australia",
          "latitude": -33.8944593,
          "longitude": 151.2252255,
          "timeZone": "Australia/Sydney",
          "types": [
            "establishment",
            "point_of_interest",
            "stadium"
          ],
          "description": "Historic outdoor amphitheater known for summer concerts",
          "image": {
            "src": "https://assets.session.services/my-image.jpg",
            "alt": "My Image",
            "width": 1080,
            "height": 1080
          }
        },
        "entryStartsAt": "2026-08-04T06:13:52",
        "entryEndsAt": "2026-08-05T06:13:52",
        "images": {
          "mobile": {
            "src": "https://assets.session.services/my-image.jpg",
            "alt": "My Image",
            "width": 1080,
            "height": 1080
          },
          "desktop": {
            "src": "https://assets.session.services/my-image.jpg",
            "alt": "My Image",
            "width": 1080,
            "height": 1080
          }
        }
      },
      "admissionId": "adm_01jps5cgsee0xvapbk92e8eb4g",
      "admission": {
        "id": "adm_01jps5cgsee0xvapbk92e8eb4g",
        "name": "VIP Access",
        "price": {
          "currency": "USD"
        },
        "entryStartsAt": "2025-03-15T19:30:00",
        "entryEndsAt": "2025-03-15T19:30:00"
      },
      "section": {
        "id": "sct_01jps5cgse0g3qj16kpq8t221r",
        "name": "Floor Section A",
        "location": {
          "timeZone": "America/New_York"
        }
      },
      "orderId": "ord_01jps5cgsfgve5b5g2666kyryh",
      "orderItemId": "itm_01jps5cgsfwyxj0516571eaf17",
      "teamId": "tem_01jqpjksnsen9vprw95et60t2m",
      "promoterId": "pmt_01jqpjksnsen9vprw95et60t2m"
    }
  ],
  "order": {
    "id": "ord_01jps5cgsfgve5b5g2666kyryh"
  }
}