Skip to content
Navigation

Lists the guests the customer bought an event's tickets for, and whether each opened theirs.

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

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

Lists the guests the customer bought an event's tickets for, and whether each opened theirs.

JSON
  • guests
    array of
    object
    required
    • id
      string
      required
    • product_id
      string
      required
    • order_id
      string
      required
    • order_item_id
      string
      required
    • name
      required

      One of the following:

      • string
      • null
    • email
      required

      One of the following:

      • string
      • null
    • status
      string
      required

      active while theirs, refunded once a refund ended it.

    • opened_at
      required

      When they signed in holding it, else first were let in at the door; null while neither.

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
    • ended_at
      required

      One of the following:

      • string
      • null
    • changeable
      boolean
      required

      Whether the buyer may still hand it to someone else: before its guest opened it, before the event starts, and while it stands.

    • resendable
      boolean
      required

      Whether the buyer may send its mail again; never once the event is canceled.

  • attending
    boolean
    required

    Whether the caller is on the event's guest list themselves.

  • lines
    array of
    object
    required

    Each line of the caller's orders of the event, oldest first.

    • order_item_id
      string
      required
    • buyer_ticket
      boolean
      required

      Whether the line kept one of its tickets for the buyer; one naming a guest for every ticket keeps none.

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