Skip to content
Navigation

Reads the customer's ticket to an event: its code for the door's QR code, its status and type, and the sessions it let them in at.

GET
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/ticket

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Returns

200

Reads the customer's ticket to an event: its code for the door's QR code, its status and type, and the sessions it let them in at.

JSON
  • product_id
    string
    required
  • ticket_code
    required

    What the ticket's QR code holds, shown at the door; null while a code is still being minted.

    One of the following:

    • string
    • null
  • status
    string
    required

    going while it lets them in, pending or waitlisted while their request waits, canceled once it no longer does.

  • cancel_reason
    required

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

    One of the following:

    • string
    • null
  • canceled_at
    required

    One of the following:

    • string
    • null
  • tier
    required

    Their ticket type; null for access with no tier.

    One of the following:

    • object
    • null
  • registered_at
    string
    required
  • check_ins
    array of
    object
    required

    The sessions it let them in at, earliest first.

    • session_id
      string
      required
    • checked_in_at
      string
      required
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