Page Comparison

...

• id - internal ticket identifier

• location - queue display name (store, department and others info)

• type - ticket type, possible values: anonymous (walk-in ticket), booking (pre-booking), manual (tickets issued by staff)

• priority - internal value

• locale - customer preferred language (en, ar, sv)

• registrationData - an optional object, provides information which customer specified during registration flow. For phone number key is fixed: phone. Format for each value is {key: {value: value}}

• notification - customer contact information

  • type - type of notifications that customer subscribed to (phoneNumber or email)

  • settings.from - not relevant/internal use

  • settings.to - customer phone number

  • settings?.recipient - customer email (in case of email or phone notifications)

• booking

  • start - timeslot start in case of bookings, local timezone

  • end - timeslot end in case of bookings, local timezone

  • virtualAppointment - keep information if it’s a virtual appointment or not. Optional

    • isEnabled - shows if it’s a virtual appointment or not (true \ false). In case of false all other fields in virtualAppointment are omitted.

    • eventId - event id specified in MS Graph api. Default user for the organisation is associated with this event.

    • url - link to ms teams call for joining

    • managerId - manager id from AD

    • managerEmail - manager email (if not specified, default manager for organisation will be used)

• status - ticket status, possible values: draft (pre-booking created but not active), pending (ticket is inside queue), notified (ticket called out by staff), fulfilled (ticket checked in by the staff), completed (ticket has been served), rejected (ticket was cancelled either by customer or staff)

• station information

  • id - internal id

  • label - label which is shown for customers and in admin

• label - assigned ticket number (A1, B2 and such)

• queue - queue identifier, can be used to correlate data

• createdAt - ticket creation time, ISO string

• fulfilledAt - time when customer checked-in datetime, ISO string

• calledAt - customer called next (by pressing call next of selecting the ticket from the list of pending tickets), ISO string

• completedAt - time when ticket was moved to completed state (after ticket was fulfilled, the terminate state), ISO string

• rejectedAt - time when ticket was rejected, ISO string

• bookingReminderAt - if configured, when the booking reminder will be sent to customer, ISO string

• QRCodeCheckInPositionId - value of the QR code to render to allow check-in by the staff

Example:

  {
    "id": "_id_",
    "location": null,
    "type": "booking",
    "priority": 100,
    "locale": "en",
    "notification": {
        "type": "phoneNumber",
        "settings": {
            "from": "",
            "to": "+phoneNumber",
            "recipient": "test@email.com"
        },
    },
    "registrationData": {
      "phone": { value: "+48888888888" },
    },
    "booking": {
        "start": "yyyy-MM-dd HH:mm", // with respect to timezone
        "end": "yyyy-MM-dd HH:mm", // with respect to timezone
        "virtualAppointment": {
          eventId: "AAMkADExYWZmYjI4LTMxMjIt......="
          isEnabled: true
          managerEmail: "virtual-booking@some-domen.com"
          managerId: "9cd376b6-......."
          url: "https://teams.microsoft.com/l/meetup-join/19....."
        }
    },
    "station": {
      "id": "1234_id",
      "label": "A"
    },
    "status": "draft",
    "label": "", // label will generated when time comes
    "queue": "_queue_id_",
    "createdAt": "2020-05-26T08:47:37.1700000Z",
    "calledAt": "2020-05-26T15:30:37.1700000Z",
    "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
    "completedAt": "2020-05-26T17:16:59.6100000Z",
    "bookingReminderAt": null,
    "QRCodeCheckInPositionId": "{"type":"check-in-position","positionId":"ce4a66df-51ff-47af-bf5e-4e26f82d266b"}"
  }

...