Skip to content
Navigation

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.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/attendees/check_in

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON required

  • session
    object
    required

    The session they are let in at.

    • id
      string
      required
      maxLength: 512 · minLength: 1
  • ticket_code
    optional
    string

    The code their ticket's QR code holds, as scanned or typed; give this or attendee.

    maxLength: 64 · minLength: 1
  • attendee
    optional
    object

    The attendee, as the guest list names them; give this or ticket_code.

    • id
      string
      required
      maxLength: 512 · minLength: 1

Returns

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.

JSON
  • checked_in
    number
    required
  • going
    number
    required
  • 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
    object
    required
    • id
      string
      required
    • status
      string
      required

      going while a grant holds, pending or waitlisted while their request waits, canceled once none does.

    • cancel_reason
      required

      Why they no longer hold the event: refunded, revoked, expired, declined, or canceled when the seller canceled it; null unless canceled.

      One of the following:

      • string
      • null
    • tier
      required

      Their ticket type; null for access with no tier.

      One of the following:

      • object
      • null
    • customer
      required

      One of the following:

      • object
      • null
  • check_in
    required

    Their check-in at the session; null while they have none.

    One of the following:

    • object
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close