Atualize o rastreamento

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/tracking \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryTrackingInfo": {
    "deliveryTrackingInfo.event": {
      "deliveryTrackingInfo.event.type": "<string>",
      "deliveryTrackingInfo.event.message": "<string>",
      "deliveryTrackingInfo.event.datetime": {}
    },
    "deliveryTrackingInfo.problem": {
      "deliveryTrackingInfo.problem.reason": "<string>",
      "deliveryTrackingInfo.problem.message": "<string>",
      "deliveryTrackingInfo.problem.datetime": {}
    },
    "deliveryTrackingInfo.vehicle": {
      "deliveryTrackingInfo.vehicle.type": {},
      "deliveryTrackingInfo.vehicle.licencePlate": "<string>"
    },
    "deliveryTrackingInfo.eta": {
      "deliveryTrackingInfo.eta.pickupEtaInMinutes": 123,
      "deliveryTrackingInfo.eta.pickupEtaDatetime": {},
      "deliveryTrackingInfo.eta.deliveryEtaInMinutes": 123,
      "deliveryTrackingInfo.eta.deliveryEtaDatetime": {},
      "deliveryTrackingInfo.eta.maxDeliveryTime": {}
    },
    "deliveryTrackingInfo.deliveryPerson": {
      "deliveryTrackingInfo.deliveryPerson.id": "<string>",
      "deliveryTrackingInfo.deliveryPerson.name": "<string>",
      "deliveryTrackingInfo.deliveryPerson.pictureURL": {}
    },
    "deliveryTrackingInfo.geoLocalization": {
      "deliveryTrackingInfo.geoLocalization.latitude": 123,
      "deliveryTrackingInfo.geoLocalization.longitude": 123,
      "deliveryTrackingInfo.geoLocalization.lastAddress": {}
    }
  }
}
'

POST

orders

{orderId}

tracking

Atualize o rastreamento

curl --request POST \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId}/tracking \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryTrackingInfo": {
    "deliveryTrackingInfo.event": {
      "deliveryTrackingInfo.event.type": "<string>",
      "deliveryTrackingInfo.event.message": "<string>",
      "deliveryTrackingInfo.event.datetime": {}
    },
    "deliveryTrackingInfo.problem": {
      "deliveryTrackingInfo.problem.reason": "<string>",
      "deliveryTrackingInfo.problem.message": "<string>",
      "deliveryTrackingInfo.problem.datetime": {}
    },
    "deliveryTrackingInfo.vehicle": {
      "deliveryTrackingInfo.vehicle.type": {},
      "deliveryTrackingInfo.vehicle.licencePlate": "<string>"
    },
    "deliveryTrackingInfo.eta": {
      "deliveryTrackingInfo.eta.pickupEtaInMinutes": 123,
      "deliveryTrackingInfo.eta.pickupEtaDatetime": {},
      "deliveryTrackingInfo.eta.deliveryEtaInMinutes": 123,
      "deliveryTrackingInfo.eta.deliveryEtaDatetime": {},
      "deliveryTrackingInfo.eta.maxDeliveryTime": {}
    },
    "deliveryTrackingInfo.deliveryPerson": {
      "deliveryTrackingInfo.deliveryPerson.id": "<string>",
      "deliveryTrackingInfo.deliveryPerson.name": "<string>",
      "deliveryTrackingInfo.deliveryPerson.pictureURL": {}
    },
    "deliveryTrackingInfo.geoLocalization": {
      "deliveryTrackingInfo.geoLocalization.latitude": 123,
      "deliveryTrackingInfo.geoLocalization.longitude": 123,
      "deliveryTrackingInfo.geoLocalization.lastAddress": {}
    }
  }
}
'

Envie atualizações depois que o pedido for despachado. O payload pode incluir evento, entregador, previsão, localização e veículo.

Parâmetros de rota

string (uuid)

required

Identificador único do pedido para o qual você está enviando atualizações. Gerado pela Onbeef e retornado no evento do pedido.

Corpo da requisição

object

required

Objeto com todos os detalhes de rastreamento desta atualização.

Show Campos de deliveryTrackingInfo

object

Evento atual da entrega.

Show Campos de event

string

Tipo do evento. Exemplos: PICKUP_ONGOING, PICKUP_ARRIVED, DELIVERY_ONGOING, DELIVERY_ARRIVED.

string

Descrição legível do evento atual.

string (date-time)

Timestamp ISO 8601 de quando o evento ocorreu.

object

Detalhes de eventuais problemas encontrados na entrega, se aplicável.

Show Campos de problem

string

Motivo do problema, por exemplo DELIVERYPERSON_OCCURRENCE.

string

Descrição do problema.

string (date-time)

Timestamp ISO 8601 de quando o problema foi reportado.

object

Informações sobre o veículo de entrega.

Show Campos de vehicle

array of strings

Tipo(s) do veículo utilizado. Exemplo: ["MOTORBIKE_BAG"].

string

Placa do veículo.

object

Detalhes do tempo estimado de chegada.

Show Campos de eta

integer

Minutos estimados até o entregador chegar à loja para retirada.

string (date-time)

Data/hora estimada da retirada.

integer

Minutos estimados até a entrega ao cliente.

string (date-time)

Data/hora estimada da entrega ao cliente.

string (date-time)

Prazo máximo aceitável para a entrega.

object

Informações do entregador.

Show Campos de deliveryPerson

string

Identificador único do entregador.

string

Nome completo do entregador.

string (url)

URL da foto de perfil do entregador.

object

Localização GPS atual do entregador.

Show Campos de geoLocalization

number

Latitude atual do entregador.

number

Longitude atual do entregador.

object

Detalhes do último endereço conhecido do entregador, incluindo country, state, city, district, street, postalCode, distanceToPickup, distanceToDelivery e timestamp.

Resposta

202: Aceito

A atualização foi aceita para processamento e será refletida no rastreamento exibido ao cliente.

401: Não autorizado

Retornado quando a requisição não inclui credenciais de autenticação válidas.

404: Não encontrado

Nenhum pedido foi encontrado com o orderId informado.

Exemplo de requisição

curl --request POST \
  --url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/tracking" \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "deliveryTrackingInfo": {
      "event": {
        "type": "PICKUP_ONGOING",
        "message": "Entregador a caminho da loja",
        "datetime": "2019-08-24T14:15:22Z"
      },
      "vehicle": {
        "type": ["MOTORBIKE_BAG"],
        "licencePlate": "ABC-1234"
      },
      "eta": {
        "pickupEtaInMinutes": 5,
        "pickupEtaDatetime": "2019-08-24T14:20:22Z",
        "deliveryEtaInMinutes": 25,
        "deliveryEtaDatetime": "2019-08-24T14:40:22Z"
      },
      "deliveryPerson": {
        "id": "courier-001",
        "name": "Carlos Souza",
        "pictureURL": "https://example.com/courier.jpg"
      },
      "geoLocalization": {
        "latitude": -23.5605,
        "longitude": -46.6433
      }
    }
  }'

curl --request POST \
  --url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479/tracking" \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "deliveryTrackingInfo": {
      "event": {
        "type": "PICKUP_ONGOING",
        "message": "Entregador a caminho da loja",
        "datetime": "2019-08-24T14:15:22Z"
      },
      "vehicle": {
        "type": ["MOTORBIKE_BAG"],
        "licencePlate": "ABC-1234"
      },
      "eta": {
        "pickupEtaInMinutes": 5,
        "pickupEtaDatetime": "2019-08-24T14:20:22Z",
        "deliveryEtaInMinutes": 25,
        "deliveryEtaDatetime": "2019-08-24T14:40:22Z"
      },
      "deliveryPerson": {
        "id": "courier-001",
        "name": "Carlos Souza",
        "pictureURL": "https://example.com/courier.jpg"
      },
      "geoLocalization": {
        "latitude": -23.5605,
        "longitude": -46.6433
      }
    }
  }'

Você pode enviar atualizações a cada 30 segundos quando a localização do entregador está mudando ativamente. No mínimo, envie uma atualização em cada marco importante: entregador saindo da sua loja, aproximando-se do endereço de entrega e qualquer problema encontrado.

Este endpoint só faz sentido depois que um pedido foi despachado. Enviar atualizações antes do despacho não terá efeito visível para o cliente.

Visão geral

Autenticação

Merchant

Pedidos

Logística

Atualize o rastreamento

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição

​Parâmetros de rota

​Corpo da requisição

​Resposta

​202: Aceito

​401: Não autorizado

​404: Não encontrado

​Exemplo de requisição

Parâmetros de rota

Corpo da requisição

Resposta

202: Aceito

401: Não autorizado

404: Não encontrado

Exemplo de requisição