Skip to Content
Modelos de DadosOrders

Orders (order)

OrderProps

Representa um pedido de compra de ingressos/produtos.

type OrderStatus = 'PENDING' | 'PAID' | 'CANCELED' | 'REFUNDED' | 'PROCESSING';
type OrderVenue = 'ONLINE' | 'PHYSICAL';
 
type OrderEventProps = Pick<
  EventProps,
  | 'id'
  | 'name'
  | 'slug'
  | 'legalAgeRequired'
  | 'hasTicketInsurance'
  | 'startsAt'
  | 'opensAt'
  | 'timezone'
  | 'image'
  | 'address'
  | 'externalAnalytics'
> & { channel: Pick<ChannelProps, 'id' | 'slug'> };
 
type OrderProps = {
  id: string;
  status: OrderStatus;
  rawPrice: number;
  totalPrice: number;
  totalFee: number;
  totalDiscount: number;
  totalRefund?: number;
  totalCreditCardFee?: number;
  totalInsurance?: number;
  processingFee?: number;
  eventId: string;
  event: OrderEventProps;
  payment?: { installments: number; type: 'PIX' | 'CREDIT_CARD' };
  buyer?: BuyerProps;
  coupon?: { usedAmount: number; coupon: Pick<CouponProps, 'id' | 'code'> };
  expiresAt: string;
  createdAt?: string;
  venue?: OrderVenue;
  stoneTransactions?: unknown[];
};

Campos principais:

  • id / status – Identificador e status atual do pedido.
  • rawPrice / totalPrice / totalFee / totalDiscount – Valores bruto, final, taxas e descontos.
  • eventId – ID do evento relacionado.
  • event – Dados resumidos do evento (OrderEventProps: id, name, slug, channel, etc.).
  • buyer? – Dados do comprador (ver BuyerProps).
  • coupon? – Informações sobre o cupom utilizado (ver CouponProps).

CreatedOrderProps

Retorno da criação de pedido (sdk.orders.create).

type CreatedOrderOrderProps = Pick<
  OrderProps,
  'id' | 'rawPrice' | 'totalPrice' | 'totalFee' | 'totalDiscount'
> & {
  utmSource: string | null;
  utmCampaign: string | null;
  buyer: BuyerProps | null;
  event: CreatedOrderEventProps;
  items: CreatedOrderItemProps[];
  info: Record<string, unknown>;
};
 
type CreatedOrderProps = {
  type: 'success';
  order: CreatedOrderOrderProps;
  clientSecret: string;
};

Campos principais:

  • type – Sempre 'success' em criação bem-sucedida.
  • order – Pedido criado (id, totais, event resumido, items com ticket e group/gauge).
  • clientSecret – Token usado para concluir o pagamento no front.

CreatedOrderEventProps / CreatedOrderItemProps / CreatedOrderItemTicketProps / CreatedOrderGroupProps

Tipos auxiliares do order em CreatedOrderProps: evento com id, name, startsAt; item com id, amount, ticket; ticket com id, name, type, price, group; grupo com id, name e opcionalmente gauge (totalAmount, usedAmount, id?).

GetOrderProps

Retorno ao buscar um pedido específico (sdk.orders.get).

type GetOrderProps = {
  order: OrderProps & {
    items: OrderItemProps[];
    userTickets: UserTicketProps[];
  };
  paidTickets: UserTicketProps[];
  paymentIntent?: PaymentIntentProps;
};

Campos principais:

  • order – Pedido completo, incluindo itens (items) e ingressos (userTickets).
  • paidTickets – Ingressos efetivamente pagos e válidos.
  • paymentIntent? – Detalhes do pagamento (PIX, cartão, etc.) (ver PaymentIntentProps).

PaymentIntentProps

Representa o estado do pagamento de um pedido.

type PaymentIntentStatus =
  | 'CANCELED'
  | 'SUCCEEDED'
  | 'PROCESSING'
  | 'FAILED'
  | 'REFUNDED'
  | 'PENDING';
 
type PaymentIntentProps = {
  id: string;
  status: PaymentIntentStatus;
  failureReason?: string; // Código do motivo da falha (quando houver)
  threeDS?: {
    url: string;
    token: string;
  };
} & (
  | { paymentMethod: 'CREDIT_CARD' }
  | { paymentMethod: 'PIX'; pix: { qrCodeUrl: string; qrCode: string } }
  | { paymentMethod: 'BANK_SLIP'; bankSlip: { externalUrl: string; barcode: string } }
  | { paymentMethod: 'FREE_OF_CHARGE' }
);

Campos principais:

  • id / status – Identificador da intenção de pagamento e status atual.
  • failureReason? – Motivo da falha (quando o pagamento não é aprovado).
  • threeDS? – Dados para fluxo 3DS (autenticação adicional de cartão).
  • paymentMethod – Método de pagamento ('PIX', 'CREDIT_CARD', etc.).
Last updated on
UsersUser Tickets