Esse documento descreve como funciona o serviço de API da Loggi e como você pode aproveitar nosso serviço de Last Mile.
Para fazer uso da nossa API, você precisa de alguns preparativos:
- Uma conta na Loggi. Você pode criar sua conta através do nosso site, seja em ambiente de testes ou produção.
- Uma chave de API (os detalhes sobre como adquirir a mesma estão descritas nesta página).
- Se você precisar registrar um endereço como uma Loja em nossa plataforma, vai precisar entrar em contato com a equipe comercial através do email [email protected].
Agora você está prestes a começar a fazer seus requests.
A partir disso você consegue estimar preços de corridas, criar pedidos e ver o estado dos pedidos feitos. Para executar tais ações você pode começar listando suas lojas com allShops
Sabendo o ID de suas lojas, você pode seguir o seguinte fluxo para ter seu pedido:
Estimar um pedido com estimate
Criar seu pedido com a mutation createRetailOrder
Conferir os estados dos seus pacotes com packageStatus
Essa API é única e serve para integrar com os produtos de Presto e Ship From Store.
Conceitos Básicos
Shop
Sua loja, ponto de partida dos seus pedidos.
- Você pode criar suas próprias lojas, qualquer dúvida, entre em contato conosco.
- Você necessariamente deve passar uma loja para criar um pedido, para isso basta buscar suas lojas com a query
allShops - Como obter as informações de minhas lojas?
Package
Indica um local de entrega.
- Um package é composto de três componentes:
| Componente | Descrição |
|---|---|
| Recipient (destinatário) | name (obrigatório) e phone (obrigatório) |
| Destination (destino) | Informações sobre o destino da entrega (lat/lng, nome da rua, número do endereço, bairro e cidade) |
| Charge Information (método de pagamento) | Método de pagamento, valor da cobrança e valor de troco (quando o método de pagamento requisitar) |
Order
Um conjunto de Packages (cada Order é atribuída a um entregador).
Requests
A Loggi possui uma API conformante com GraphQL.
Integrações
Recomendamos usar a ferramenta Insomnia, que sabe fazer requisições GraphQL corretamente.
Headers
Todas as requisições devem ter o header:
| Tipo | Valor |
|---|---|
Content-Type | application/json |
Authorization | ApiKey email:api_key |
Updated 2 months ago