Detalhe do evento
Um evento, com o catálogo para exibir ou vender.
GET
/v1/event/{id}Além de título, data e local, vêm seções, lotes, cupons, addons e o mapa. Se o evento não existe ou a chave não pode vê-lo, a API devolve 404.
Requer a permissão
EVENTS_READ
Path
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | Id do evento. |
Campos
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id do evento. |
| title | string | Título. |
| description | string | Descrição. |
| place | string | Local. |
| address | object | null | Endereço público: fullAddress, zipcode, street, number, neighborhood, city, state, complement, country, location. |
| startAt | ISO-8601 | Início do evento. |
| endAt | ISO-8601 | Fim do evento. |
| url | string | Slug público. |
| flyers | string[] | URLs dos flyers. |
| type | EVENT_TYPE_ENUM | Hoje: PARTY. |
| genres | EVENT_GENRE_ENUM[] | Gêneros. |
| attractions | string[] | Atrações. |
| classification | number | null | Classificação etária. |
| isPrivate | boolean | Se o evento é privado. |
| playlist | string | null | URL da playlist do Spotify. |
| conditionsOfPurchaseUrl | string | null | URL das condições de compra. |
map
| Campo | Tipo | Descrição |
|---|---|---|
| map | string | null | URL da imagem do mapa. |
mapHotspots[]
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id da região do mapa. |
| points[] | { x, y }[] | Polígono na imagem. x e y de 0 a 1. |
| sectionId | string | null | Seção que essa região seleciona. |
| tierId | string | null | Lote que essa região seleciona. |
| optionId | string | null | Opção do lote que essa região seleciona. Igual a options[]._id. |
addons[]
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id do addon. |
| name | string | Nome do addon. |
| isActive | boolean | Se ingressos novos ainda podem receber este addon. |
sections[]
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id da seção. |
| name | string | Nome da seção. |
| description | string | null | Descrição da seção. |
| whitelist | string[] | E-mails que podem ver os lotes desta seção. Vazio = qualquer pessoa. |
| customFields[] | object[] | _id, label, type (TEXT | DATE | OPTIONS | DOCUMENT), options. |
| addons[] | object[] | Addons ativos selecionados na seção. |
| tiers[] | object[] | Lotes da seção. Ver tabela de lote. |
sections[].tiers[]
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id do lote. |
| name | string | Nome do lote. |
| description | string | null | Descrição do lote. |
| value | number | Valor em centavos. |
| availableQuantity | number | null | Quantidade de catálogo. null = ilimitado. Não é estoque restante em tempo real. |
| startAt | ISO-8601 | Abertura do lote. |
| endAt | ISO-8601 | null | Fechamento do lote. |
| visibility | PUBLIC | PRIVATE | MEMBERS | Lotes PRIVATE e MEMBERS entram porque o caller é a produtora. |
| options[] | { _id, label }[] | _id é o mesmo valor de mapHotspots[].optionId. |
| whitelist | string[] | E-mails que podem ver este lote. Vazio = qualquer pessoa. |
coupons[]
| Campo | Tipo | Descrição |
|---|---|---|
| _id | string | Id do cupom. |
| code | string | Código. |
| discountType | PERCENTAGE | FIXED | Tipo do desconto. |
| percentageDiscount | number | Percentual quando o tipo é PERCENTAGE. |
| fixedDiscountValue | number | null | Valor fixo em centavos. null se percentual. |
| isActive | boolean | Se o cupom está ativo. |
| availableQuantity | number | null | Quantidade de catálogo. null = ilimitado. |
| limitPerUser | number | null | Limite por usuário. null = ilimitado. |
| tiersIds | string[] | Lotes em que vale. Vazio = todos. |
| visibility | PUBLIC | PRIVATE | MEMBERS | Visibilidade do cupom. |
| isPublic | boolean | Se o comprador pode selecionar na compra. |
| paymentMethodScope | ALL | PIX | CREDIT_CARD | Meios de pagamento aceitos. |
| parentCouponId | string | null | Id do cupom pai quando este é um subcupom. |
| canGenerateOrder | boolean | Se o cupom pode gerar pedido. |
| canCreateSubCoupon | boolean | Se o cupom pode gerar subcupons. |
| whitelist | string[] | E-mails que podem usar este cupom. Vazio = qualquer pessoa. |