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
        }
        driver {                
          fullName             
          docLicensePlate {
            number
         }
      }
   }
}

Argumentos

📘

Identificador do pedido

O id é obtido na resposta da criação do pedido no campo orders.pk.

NomeTipoDescriçãoExemplo
idIntIdentificador 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
        }
        driver {                
          fullName             
          docLicensePlate {
            number
         }
      }
   }
}

Resposta

Campos

NomeTipoDescrição
statusEnum OrderStatusStatus do pedido.
currentDriverPositionDriverPositionPosição do entregador.
packagesList<Package>Informações sobre os pontos de parada.
pricingPricingInformações sobre precificação da corrida.
driverDriverInformações do entregador.

Enum OrderStatus

StatusDescriçãoQuando acontece?Status finalizador?
going_to_pickupEm rota de coleta.Entregador está indo até um ponto de coleta.
going_to_deliverEm rota de entrega.Entregador está indo até um ponto de entrega.
acceptedAceita.Entregador aceitou a corrida.
allocatingAguardando alocação.Procurando entregador para a corrida.
finishedTerminada.Pacotes entregues.S
cancelledWithChargeCancelada com cobrança.Pedido cancelado após um entregador ser alocado (independente do tempo).S
cancelledCancelada.Rota cancelada antes da alocação do entregador.S
droppedNão alocada.Rota não foi alocada dentro do tempo limite.S
droppedThenCancelledNão alocada e cancelada.Não foi alocada e foi cancelada.S
awaiting_completionAguardando finalização.Um pacote ainda está com o entregador e será entregue posteriormente.
mergedPedido agrupado.Quando dois pedidos são agrupados em um só (via interface).

Abaixo, apresentamos um diagrama que ilustra as possíveis transições de status.


DriverPosition

NomeTipoDescrição
latFloatLatitude da posição do entregador.
lngFloatLongitude da posição do entregador.
currentWaypointIndexIntÍndice do ponto que o entregador está cumprindo na rota.

Package

NomeTipoDescrição
statusHistoryList<StatusHistory>Lista com dois itens. Um informa sobre a retirada e o outro sobre a entrega.

StatusHistory

NomeTipoDescrição
recipientNameStringNome de quem recebeu/entregou o pacote.
recipientSignatureUrlStringLink para assinatura de quem recebeu/entregou o pacote.
waypointWaypointPonto de entrega/coleta.

Pricing

NomeTipoDescrição
totalCmStringPreço estimado do frete.

Driver

NomeTipoDescrição
fullNameStringNome completo do entregador.
docLicensePlateDocLicensePlateInformações sobre a placa do veículo.

DocLicensePlate

NomeTipoDescrição
numberStringPlaca do veículo.

Waypoint

NomeTipoDescrição
statusEnum WaypointStatusStatus do ponto de parada.
indexIntÍndice da parada na requisição.
addressDisplayStringEndereço do ponto.
etaLongTempo estimado de chegada ao ponto.

Enum WaypointStatus

StatusDescriçãoStatus finalizador?
allocatingAguardando alocação de entregador.
going_to_pickupEntregador está indo coletar pacote.
picked_upPacote coletado.S
going_to_deliverEntregador está indo para o endereço de entrega.
deliverEntregador está no endereço de entrega.
deliveredPacote entregue.S
failedEntrega 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"
            },
            "driver": {
                "fullName": "Nome do entregador",
                "docLicensePlate": {
                    "number": "ABC-1234"
                }
            }
        }
    }
}

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"
            },
            "driver": {
                 "fullName": "Nome do Entregador",
                 "docLicensePlate": {
                     "number": "ABC-1234"
                }
            }
        }
    }
}

Erros

Pedido não existe

{
   "data":{
      "order":null
   }
}