API Reference

Get Ticketing Orders

This API used to get ticketing order data associated with the specified event. This API can be access by event admin and super admin. It will return list of orders data like orderId, cardType, orderType, deliveryMode, totalAmount, purchaseDate, status, note and many more.To call this API, user have to pass query param with API URL like eventurl, searchString, dataType, searchDate, page, size, recurringEventId and authentication key to authenticate user.This API used at host side to get ticketing order details

Here is the description of response attributes, which returns to the form of JSON.

Attribute

Description

status

It's contains the order status e.g. paid, partially paid or refunded.

totalAmount

It's contains the number of order amount.

id

It's contains the field for host order list.

salesTaxFee

It's contains the sales tax fee.

ticketingFee

It's contains the ticketing fee.

ccFee

It's contains the ticketing orders CC fee.

purchaser

It's contains the order purchaser information.

  • *firstName:** It's contains the purchaser first name. Only 50 Characters are allowed in firstName.
  • *lastName:** It's contains the purchaser last name. Only 50 Characters are allowed in lastName.
  • *email:** It's contains the purchaser email. Only 75 Characters are allowed in email.

purchaseDate

It's contains the order purchase date.

orderType

It's type of order, It will return type of order like CASH, CARD, COMPLIMENTARY, UNPAID, UNPAID_DELETE, APP Or EXTERNAL_TRANSACTION.

cardType

It's contains the card type used while ordering.

lastFour

It's contains the last four digits of card.

note

Additional note added for manually entered note on staff or host page.

attendee

list of attendees

  • *firstName:** It's contains the first name of attendee.
  • *lastName:** It's contains the last name of attendee.
  • *email:** It's contains the email of attendee.
  • *qty:** It's contains the number of tickets.
  • *ticketType:** It's contains the type of ticket.
  • *bundleType:** It's contains the type of ticket bundle, value will null if found individual ticket bundle type.
  • *paidAmount:** It's total amount paid for a ticket.
  • *status:** It's contains the attendee order status, e.g. paid, unpaid etc.
  • *eventTicketingId:** it's contains the event ticketing id.
  • *isTable:** is ticket type is table?
  • *seatNumber:** It's contains the number of seat.
  • *dataType:** It's contains the data Type e.g. TICKET, ADDON.
  • *blocked:** It's contains the attendee is blocked or not.
  • *userId:** It's contains the user id.
  • *isPaidTicket:** It's checking is paid ticket or not.
  • *phoneNumber:** It's contains the phone number of attendee.

currency

It's contains the order currency.

timezoneId

It's contains the order timezone.

equivalentTimezone

It's contains the equivalent time zone, e.g. Asia/Calcutta.

recurringEventDate

It's contains the recurring event date.

orderId

It's contains the order id.

deliveryMode

It's contains the delivery mode like email, Printed,On Call or At Door Sale.

speakerOrder

It's contains the order for speaker.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

200

ticketing order array

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4030101

Not staff User

Language
Credentials
Header
Click Try It! to start a request and see the response here!