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
CampoTipoDescrição
idstringId do evento.
Campos
CampoTipoDescrição
_idstringId do evento.
titlestringTítulo.
descriptionstringDescrição.
placestringLocal.
addressobject | nullEndereço público: fullAddress, zipcode, street, number, neighborhood, city, state, complement, country, location.
startAtISO-8601Início do evento.
endAtISO-8601Fim do evento.
urlstringSlug público.
flyersstring[]URLs dos flyers.
typeEVENT_TYPE_ENUMHoje: PARTY.
genresEVENT_GENRE_ENUM[]Gêneros.
attractionsstring[]Atrações.
classificationnumber | nullClassificação etária.
isPrivatebooleanSe o evento é privado.
playliststring | nullURL da playlist do Spotify.
conditionsOfPurchaseUrlstring | nullURL das condições de compra.
map
CampoTipoDescrição
mapstring | nullURL da imagem do mapa.

mapHotspots[]

CampoTipoDescrição
_idstringId da região do mapa.
points[]{ x, y }[]Polígono na imagem. x e y de 0 a 1.
sectionIdstring | nullSeção que essa região seleciona.
tierIdstring | nullLote que essa região seleciona.
optionIdstring | nullOpção do lote que essa região seleciona. Igual a options[]._id.
addons[]
CampoTipoDescrição
_idstringId do addon.
namestringNome do addon.
isActivebooleanSe ingressos novos ainda podem receber este addon.
sections[]
CampoTipoDescrição
_idstringId da seção.
namestringNome da seção.
descriptionstring | nullDescrição da seção.
whiteliststring[]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[]
CampoTipoDescrição
_idstringId do lote.
namestringNome do lote.
descriptionstring | nullDescrição do lote.
valuenumberValor em centavos.
availableQuantitynumber | nullQuantidade de catálogo. null = ilimitado. Não é estoque restante em tempo real.
startAtISO-8601Abertura do lote.
endAtISO-8601 | nullFechamento do lote.
visibilityPUBLIC | PRIVATE | MEMBERSLotes PRIVATE e MEMBERS entram porque o caller é a produtora.
options[]{ _id, label }[]_id é o mesmo valor de mapHotspots[].optionId.
whiteliststring[]E-mails que podem ver este lote. Vazio = qualquer pessoa.
coupons[]
CampoTipoDescrição
_idstringId do cupom.
codestringCódigo.
discountTypePERCENTAGE | FIXEDTipo do desconto.
percentageDiscountnumberPercentual quando o tipo é PERCENTAGE.
fixedDiscountValuenumber | nullValor fixo em centavos. null se percentual.
isActivebooleanSe o cupom está ativo.
availableQuantitynumber | nullQuantidade de catálogo. null = ilimitado.
limitPerUsernumber | nullLimite por usuário. null = ilimitado.
tiersIdsstring[]Lotes em que vale. Vazio = todos.
visibilityPUBLIC | PRIVATE | MEMBERSVisibilidade do cupom.
isPublicbooleanSe o comprador pode selecionar na compra.
paymentMethodScopeALL | PIX | CREDIT_CARDMeios de pagamento aceitos.
parentCouponIdstring | nullId do cupom pai quando este é um subcupom.
canGenerateOrderbooleanSe o cupom pode gerar pedido.
canCreateSubCouponbooleanSe o cupom pode gerar subcupons.
whiteliststring[]E-mails que podem usar este cupom. Vazio = qualquer pessoa.