Tipos de webhook

Pedido

A mensagem é enviada apenas quando há uma atualização no status do pedido.

{
  Id: 123,
  UsuarioId: 456,
  PedidoId: 789,
  PedidoEntregaId: 'ABCDE', // Propriedade é opcional
  PedidoEntregaIdExterno: 'EXT-12345', // Propriedade é opcional
  Situacao: 2,
  Topico: 'pedido',
  Origem: 'INTEGRATION',
  Tentativas: 2,
  ValorCorrida: 50.75, // Valor da corrida em reais
  DistanciaTotalEmKm: 12.5, // Distância total em quilômetros
  CodigoExterno: 'XYZ987',
  CodigoExternoCompleto: 'ABC123',
  TrackingUrl: 'https://example.com/tracking/123',
  TempoEstimadoEmSegundosAteDestino: 1800, // 30 minutos
  TempoEstimadoEmSegundosPorPedidoEntrega: [
    {
      PedidoEntregaId: 'ABCDE',
      TempoEstimadoEmSegundos: 600, // 10 minutos para o primeiro pedido
    },
    {
      PedidoEntregaId: 'FGHIJ',
      TempoEstimadoEmSegundos: 1200, // 20 minutos para o segundo pedido
    },
  ],
  Entregador: { // Propriedade 'Entregador 'é opcional
    Id: 7890,
    Nome: 'João Silva',
    Telefone: '1112345678', // Propriedade é opcional
    Latitude: -23.567, // Propriedade é opcional
    Longitude: -46.789, // Propriedade é opcional
  },
  CriacaoData: new Date(),
  AlteracaoData: new Date(),
}

Pedido entrega

A mensagem é enviada apenas quando há uma atualização no status do pedido e no pedido entrega - somente será enviada nos status '25', '30', '90' e '110'.

{
  Id: 2,
  UsuarioId: 456,
  PedidoId: 789,
  PedidoEntregaId: '12345',
  PedidoEntregaIdExterno: 'EXT-54321',
  Situacao: 2,
  Topico: 'pedido',
  Origem: 'INTEGRATION',
  Tentativas: 2,
  CodigoExterno: 'DEF456',
  CodigoExternoCompleto: 'PQR987',
  TrackingUrl: 'https://example.com/tracking',
  TempoEstimadoEmSegundosAteDestino: 2400, // 40 minutos
  CriacaoData: new Date(),
  AlteracaoData: new Date(),
  Entregador: {
    Id: 7890,
    Nome: 'João Silva',
    Telefone: '1112345678',
    Latitude: -23.567,
    Longitude: -46.789,
  },
}

Localização

Payload de envio de atualizações da localização do entregador relacionado ao pedido.

O envio de geolocalização do entregador relacionado ao pedido é realizado somente quando solicitado pelo usuário.

Essas atualizações são enviadas a cada x segundos, de acordo com a parametrização definida pelo cliente, e são disponibilizados através de um webhook que contém a latitude e longitude atualizadas do entregador. Isso permite que o parceiro possa renderizar a localização do entregador em um mapa de sua escolha.

É importante ressaltar que, temporariamente, a solicitação da parametrização deve ser realizada junto ao time técnico da Mottu, mas em breve estará disponível no portal do Web Lojista. Além disso, devido à Lei Geral de Proteção de Dados (LGPD), não é possível o envio de dados pessoais do entregador, como CPF e telefone. Caso necessário, o contato direto com o entregador deve ser realizado através do suporte da Mottu.

{
  "Id": 1674592772821,
  "UsuarioId": 99999,
  "PedidoId": 99999,
  "Situacao": 30,
  "Topico": "localização",
  "Tentativas": 1,
  "CodigoExterno": "999999",
  "CodigoExternoCompleto": null,
  "TrackingUrl": "https://delivery.mottu.cloud/pedido-acompanhamento/cliente/99999",
  "TempoEstimadoEmSegundosAteDestino": 0,
  "CriacaoData": "2023-01-24T20:39:32.821Z",
  "AlteracaoData": "2023-01-24T20:39:32.821Z",
  "Entregador": {
    "Nome": "José da Silva",
    "Id": 999999,
    "Latitude": -23.5708092,
    "Longitude": -46.7055064
  }
}

Last updated