Получить заказы события


GET /v1/events/{event_id}/orders

Группа: Заказы


Описание

Метод возвращает список заказов. Внимание! Это не выгрузка списка билетов, это именно выгрузка списка заказов. Информация по конкретным билетам находится внутри объекта заказа.

Параметры

Имя Описание Тип Тип данных  
limit Сколько элементов списка вывести query integer, { x ∈ ℤ | 1 ≤ x ≤ 250 } 10  
skip С какого элемента списка начать вывод query integer, { x ∈ ℤ | x ≥ 0 }  
email email пользователя query string  
event_id Номер события, к которому относятся заказы path integer

Ответ

Список заказов

RegistrationOrdersResponse

total: integer — «required»
Количество заказов в событии

values: RegistrationOrderResponse[] — «required»
Массив заказов

RegistrationOrderResponse

id: integer«required»
Id заказа

created_at: string (date) «required»
Дата создания заказа

status: OrderStatusResponse«required»
Статус заказа

  • name: string«required»
    Идентификатор статуса
  • title: string«required»
    Человекочитаемый статус заказа

mail: string
Адрес электронной почты заказчика билетов. Если режим регистрации на ваше событие находится в положении «Простая регистрация» или «Мультирегистрация», здесь будет находиться адрес электронной почты из поля «E-mail» формы покупки билетов. Если режим регистрации выставлен как «Мультианкета», то здесь будет находиться адрес электронной почты первого участника. В некоторых случаях, когда форма регистрации настроена на отображение отдельной формы заказчика, в этом поле будет находиться адрес электронной почты из этой формы.

payment: PaymentResponse 
Объект информации о платеже

  • amount: number (float)«required»
    Оплаченная сумма (количество рублей, отданных покупателем платёжной системе в этом заказе)
  • paid_at: string (date)
    Дата оплаты
  • payment_type: string
    Платёжная система оплаты
  • payment_link: string
    Ссылка на оплату

tickets: TicketResponse[] — «required»
Список регистраций

TicketResponse

id: integer — «required»
Id билета

number: string
Номер билета

price_nominal: number
Номинальная цена билета на момент покупки. ВНИМАНИЕ! Эта цена не учитывает начисленные скидки на заказ и является ценой заказанной категории билета на момент его оплаты.

answers: object — «required»
Объект с ответами на вопросы анкеты

string
ticket_type: TicketTypeResponse«required»
Объект информации о типе билета

  • id: integer — «required»
    Уникальный номер типа билета
  • name: string «required»
    Название типа билета
  • description: string
    Описание типа билета
  • buy_amount_min: number — «required»
    Минимальное количество билетов в одной покупке
  • buy_amount_max: number — «required» 
    Максимальное количество билетов в одной покупке
  • price: number «required»
    Цена билета
  • is_promocode_locked: boolean — «required»
    Закрыт ли этот тип билета введённым промокодом
  • remaining: integer — «required»
    Сколько билетов осталось
  • sale_ends_at: string (date) «required»
    Дата окончания продажи типа билета
  • sale_starts_at: string (date)
    Дата начала продажи типа билета
  • public_key: string «required»
    Публичный ключ для расшифровки QR-кода билета этого типа
  • is_active: boolean «required»
    Активность типа билета
  • ad_partner_profit: number
    Партнёрская прибыль
  • send_personal_links: boolean
    Отправка персональных ссылок
  • sold: number
    Количество проданных билетов
  • attended: number
    Количество посетивших людей
  • limit: number
    Ограничение на количество билетов в этом типе билета
  • status: string
    Статус типа билета

attendance: AttendanceResponse 
Объект информации о посещении пользователя с этим билетом

  • starts_at: string (date)
    Дата посещения события
  • ends_at: string (date)
    Дата ухода с события

place: PlaceResponse 
Объект информации о месте билета

  • id: string — «required»
    Идентификатор места
  • description: object
    Объект описания места

codes: CodesResponse 
Объект информации о кодах билета

  • ean13: string
    ean13 код билета
  • ean8: string
    ean8 код билета
  • printed_code: string
    Код, который будет напечатан на билете

personal_link: string
Персональная ссылка

eticket_link: string
Ссылка на электронный билет

 
 

answers: object — «required»
Массив Ответов

string

promocodes: string[]
Список промокодов

  • string

event: OrderEventResponse 
Краткая информация о событии

  • id: integer«required»
    Id События

referrer: OrderReferrerResponse 
Источники трафика

  • campaign: string
    Кампания
  • medium: string
    Канал
  • source: string
    Источник

subscribed_to_newsletter: boolean
Подписка на анонсы событий организатора

 
 

 

 
 

Права доступа

Необходимые права доступа — view_visitors

Эта статья была полезной?