Requisição
Substitua as variáveis e use esta consulta:
query {
order(id: PK_ORDER) {
status
eta
originalEta
currentDriverPosition {
lat
lng
currentWaypointIndex
}
packages {
pickupWaypoint {
status
index
addressDisplay
eta
}
statusHistory {
recipientName
recipientSignatureUrl
waypoint {
status
index
addressDisplay
eta
}
}
}
pricing {
totalCm
}
}
}
Argumentos
Identificador do pedido
O id é obtido na resposta da criação do pedido no campo
orders.pk
.
Nome | Tipo | Descrição | Exemplo |
---|---|---|---|
id | Int | Identificador do pedido. | 47950616 |
Exemplo
query {
order(id: 47981652) {
status
eta
originalEta
currentDriverPosition {
lat
lng
currentWaypointIndex
}
packages {
pickupWaypoint {
status
index
addressDisplay
eta
}
statusHistory {
recipientName
recipientSignatureUrl
waypoint {
status
index
addressDisplay
eta
}
}
}
pricing {
totalCm
}
}
}
Resposta
Campos
Nome | Tipo | Descrição |
---|---|---|
status | Enum OrderStatus | Status do pedido. |
currentDriverPosition | DriverPosition | Posição do entregador. |
packages | List<Package> | Informações sobre os pontos de parada. |
Enum OrderStatus
Status | Descrição | Quando acontece? | Status finalizador? |
---|---|---|---|
going_to_pickup | Aguardando alocação. | Pedido criado e aguardando o processo de entrar em alocação. | |
going_to_deliver | Em alocação. | Procurando entregador para a corrida. | |
accepted | Aceita. | Entregador aceitou a corrida. | |
started | Iniciada. | Entregador concluiu o ponto de coleta. | |
finished | Terminada. | Pacotes Entregues/Cancelados. | S |
cancelledWithCharge | Cancelada com cobrança. | Pedido cancelado após um entregador ser alocado (independente do tempo). | S |
cancelled | Cancelada. | Rota cancelada antes da alocação do entregador. | S |
dropped | Não alocada. | Rota não foi alocada dentro do tempo limite. | S |
droppedThenCancelled | Não alocada e cancelada. | Não foi alocada e foi cancelada. | S |
awaiting_completion | Aguardando finalização. | Um pacote ainda está com o entregador e será entregue posteriormente. | |
merged | Pedido agrupado. | Quando dois pedidos são agrupados em um só (via interface) |
DriverPosition
Nome | Tipo | Descrição |
---|---|---|
lat | Float | Latitude da posição do entregador. |
lng | Float | Longitude da posição do entregador. |
currentWaypointIndex | Int | Índice do ponto que o entregador está cumprindo na rota. |
Package
Nome | Tipo | Descrição |
---|---|---|
statusHistory | List<StatusHistory> | Lista com dois itens. Um informa sobre a retirada e o outro sobre a entrega. |
StatusHistory
Nome | Tipo | Descrição |
---|---|---|
recipientName | String | Nome de quem recebeu/entregou o pacote. |
recipientSignatureUrl | String | Link para assinatura de quem recebeu/entregou o pacote. |
waypoint | Waypoint | Ponto de entrega/coleta. |
Waypoint
Nome | Tipo | Descrição |
---|---|---|
status | Enum WaypointStatus | Status do ponto de parada. |
index | Int | Índice da parada na requisição. |
addressDisplay | String | Endereço do ponto. |
eta | Long | Tempo estimado de chegada ao ponto. |
Enum WaypointStatus
Status | Descrição | Status finalizador? |
---|---|---|
allocating | Aguardando alocação de entregador. | |
going_to_pickup | Entregador está indo coletar pacote. | |
picked_up | Pacote coletado. | S |
going_to_deliver | Entregador está indo para o endereço de entrega. | |
deliver | Entregador está no endereço de entrega. | |
delivered | Pacote entregue. | S |
failed | Entrega cancelada. | S |
waiting_slo |
Exemplos
Sucesso
Pedido com um único ponto de entrega
{
"data": {
"order": {
"status": "finished",
"eta": 1731421546,
"originalEta": 1104,
"currentDriverPosition": null,
"packages": [
{
"statusHistory": [
{
"recipientName": "Beatriz",
"recipientSignatureUrl": "https://s3-sa-east-1.amazonaws.com/loggi-production-media/packages/426939826/8766660282/wp-3766101692-protocolo.png",
"waypoint": {
"status": "delivered",
"index": 1,
"addressDisplay": "Avenida Luigi Papaiz, 239 - Campanário, Diadema - SP, 09931-610, Brasil - Modulo 4 - Galpão F, Campanário, Diadema, SP, 09931610",
"eta": null
}
},
{
"recipientName": "Jussara",
"recipientSignatureUrl": "https://s3-sa-east-1.amazonaws.com/loggi-production-media/packages/426939826/8766660281/wp-3766101691-protocolo.png",
"waypoint": {
"status": "delivered",
"index": 0,
"addressDisplay": "Rua das Figueiras, 1601 - Jardim, Santo André - SP, 09080-371, Brasil - Clínica Dermo Saúde, Jardim, Santo André, SP, 09080371",
"eta": null
}
}
]
}
],
"pricing": {
"totalCm": "35.26"
}
}
}
}
Pedido com três pontos de entrega
{
"data": {
"order": {
"status": "dropped",
"eta": 1731437482,
"originalEta": 3617,
"currentDriverPosition": null,
"packages": [
{
"statusHistory": [
{
"recipientName": null,
"recipientSignatureUrl": null,
"waypoint": {
"status": "failed",
"index": 1,
"addressDisplay": "Rua Mantena, 290 - Ouro Preto, Belo Horizonte - MG, 31310-430, Brasil - Sala 1, Ouro Preto, Belo Horizonte, MG, 31310430",
"eta": null
}
},
{
"recipientName": null,
"recipientSignatureUrl": null,
"waypoint": {
"status": "failed",
"index": 0,
"addressDisplay": "Rua Curupaiti, 513 - Padre Eustáquio, Belo Horizonte - MG, 30730-130, Brasil, Padre Eustáquio, Belo Horizonte, MG, 30730130",
"eta": null
}
}
]
},
{
"statusHistory": [
{
"recipientName": null,
"recipientSignatureUrl": null,
"waypoint": {
"status": "failed",
"index": 2,
"addressDisplay": "Rua Major Lage, 84 - Ouro Preto, Belo Horizonte - MG, 31310-200, Brasil - Sem., Ouro Preto, Belo Horizonte, MG, 31310200",
"eta": null
}
},
{
"recipientName": null,
"recipientSignatureUrl": null,
"waypoint": {
"status": "failed",
"index": 0,
"addressDisplay": "Rua Curupaiti, 513 - Padre Eustáquio, Belo Horizonte - MG, 30730-130, Brasil, Padre Eustáquio, Belo Horizonte, MG, 30730130",
"eta": null
}
}
]
}
],
"pricing": {
"totalCm": "23.59"
}
}
}
}
Erros
Pedido não existe
{
"data":{
"order":null
}
}