Skip to main content

Campos

CampoTipoDescrição
orderIdUUIDIdentificador único
checkoutIdUUIDReferência ao checkout da compra
customerIdUUIDReferência ao cliente comprador
organizationIdUUIDReferência à organização da empresa
companyIdUUIDReferência à empresa responsável pelos tickets do pedido
soldByIdUUIDReferência ao usuário responsável pela criação do pedido
externalProviderStringNome do provedor externo
externalProviderIdStringID do pedido no provedor externo
typeOrderTypeOrigem da compra
codeStringCódigo legível único do pedido
amountIntValor total do pedido em centavos
statusOrderStatusStatus do pedido (default PENDING)
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização

Relacionamentos

Regras de Negócio

  • Agrupa tickets de uma única empresa dentro de um checkout.
  • Um checkout com tickets de múltiplas empresas gera um Order por empresa.
  • Um Order pode receber uma TripReview por Trip comprada.
  • Um checkout pode ter múltiplos TripReviews porque pode gerar múltiplos Orders e Trips.
  • customerId é obrigatório também em vendas POS.
  • Na venda POS, o sistema resolve ou cria User + Customer antes de criar o Order.
  • Quando a venda POS cria uma conta nova, o sistema emite um Invite ACCOUNT_ACTIVATION para o customer usar o app depois.
  • O valor (amount) é armazenado em centavos — ex.: R$ 150,00 = 15000.
  • O amount do Order é a soma dos tickets daquela empresa.
  • Promoções e créditos só podem ser aplicados quando pertencem à mesma companyId do Order.
  • O campo code é um identificador legível único para o pedido.

Enums

OrderType

ValorDescrição
ONLINEVenda via canal digital
POSVenda presencial ou guichê

OrderStatus

ValorDescrição
PENDINGPedido pendente de confirmação de pagamento
PAIDPagamento confirmado
PAYMENT_FAILEDPagamento recusado
CANCELEDPedido cancelado

Example

{
  "orderId": "0197a813-0fb9-7d42-9c81-50c0f6d9ae5a",
  "checkoutId": "0197a812-b835-79c4-8f0b-0e3863eb6d34",
  "customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
  "organizationId": "0197a801-1690-7590-b3cf-19599b9be3e4",
  "companyId": "0197a801-6a42-79aa-9e56-d3c85148c0fa",
  "soldById": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "externalProvider": "billing_interface",
  "externalProviderId": "ord_6e3d7a21",
  "type": "ONLINE",
  "code": "OAB-20260703-0001",
  "amount": 11400,
  "status": "PAID",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T16:00:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T16:02:00.000Z"
}