# Obter informação da rota

## Consulta de rota

> Recuperar dados de uma rota.

```json
{"openapi":"3.0.0","info":{"title":"API Shippify","version":"1.0.0"},"servers":[{"url":"https://api.shippify.co","description":"Servidor de desenvolvimento"}],"security":[{"Basic_Auth":[]}],"components":{"securitySchemes":{"Basic_Auth":{"type":"http","scheme":"basic"}},"schemas":{"getRoute":{"successfullResponse":{"type":"object","description":"Information of the consulted route","properties":{"payload":{"type":"object","properties":{"route":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the route in shippify."},"city":{"type":"object","description":"Information of the city where the route's deliveries are collected","properties":{"id":{"type":"string","description":"Identifier of the city in Shippify"},"name":{"type":"string","description":"Name of the city"}}},"deliveries":{"type":"array","description":"Deliveries belonging to the consulted route","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the delivery in shippify"},"referenceId":{"type":"string","description":"External identifier of the delivery, it can be the order number"},"state":{"description":"Código de status da entrega","type":"integer","minimum":1,"maximum":7},"status":{"type":"string","description":"Name of the delivery status"},"company":{"type":"object","description":"Company information of the delivery.","properties":{"id":{"description":"Company identifier.","type":"integer","minimum":1},"name":{"type":"string","description":"Company name."}}},"pickup":{"description":"Informações de coleta","type":"object","properties":{"location":{"$ref":"#/components/schemas/delivery/location"},"timeWindow":{"type":"object","description":"Date and time range for the pickup of the delivery.","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"contact":{"$ref":"#/components/schemas/delivery/contact"}}},"dropoff":{"description":"Informações de entrega","type":"object","properties":{"location":{"$ref":"#/components/schemas/delivery/location"},"timeWindow":{"type":"object","description":"Date and time range for the delivery of the packages.","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"contact":{"$ref":"#/components/schemas/delivery/contact"}}},"fare":{"type":"object","description":"Delivery values","properties":{"service":{"type":"number","description":"Preço da entrega"},"cash":{"type":"number","description":"Value that the driver must collect from the client upon completing the delivery"},"currencyCode":{"type":"string","description":"Currency of the delivery values"}}},"packages":{"type":"object","description":"Pacotes de entrega","properties":{"capacity":{"description":"Capacidade da entrega","type":"integer","minimum":1,"maximum":5},"contents":{"description":"Informações dos pacotes.","type":"array","items":{"$ref":"#/components/schemas/delivery/package"}}}},"tags":{"description":"Nomes das etiquetas digitais","type":"array","items":{"description":"Nome da etiqueta digital","type":"string","maxLength":50}},"receiver":{"description":"Recipient contact information","$ref":"#/components/schemas/delivery/contact"},"chargedDistance":{"description":"Charged distance","type":"number","minimum":0},"routeDistance":{"description":"Route distance","type":"number","minimum":0},"deliveryType":{"description":"Tipo de entrega","type":"string","enum":["flex","express","slot"]},"jobId":{"description":"Identifier of the external process that was created","type":"string"}}}},"status":{"type":"string","description":"Name of the route status"},"minimumCapacity":{"description":"Minimum route capacity","type":"integer","minimum":1,"maximum":5},"stepIds":{"type":"array","description":"Ordered steps of the route.","items":{"type":"object","properties":{"deliveryId":{"description":"Delivery identifier","type":"string"},"activityType":{"description":"Type of step, can be pickup or dropoff","type":"string"}}}}}}}}}}},"delivery":{"location":{"description":"Informações do endereço do local de coleta dos pacotes de entrega.","type":"object","required":["address"],"properties":{"address":{"description":"Endereço de entrega.","type":"string"},"instructions":{"description":"Informações extras sobre o endereço.","type":"string"},"lat":{"description":"Latitude do ponto de coleta.","type":"string"},"lng":{"description":"Longitude do ponto de coleta.","type":"string"}}},"contact":{"description":"Informações de contato da pessoa responsável por entregar os pacotes no armazém de coleta.","type":"object","required":["name","email"],"properties":{"name":{"description":"Nome da pessoa responsável.","type":"string"},"email":{"description":"Email da pessoa responsável.","type":"string","format":"email"},"phonenumber":{"description":"Número de telefone da pessoa responsável.","type":"string"}}},"package":{"type":"object","required":["name","qty","size"],"properties":{"id":{"type":"string","description":"Identificador do pacote"},"name":{"type":"string","description":"Nome do pacote"},"qty":{"description":"Número de pacotes no pedido (não o número de produtos dentro do pacote).","type":"integer","minimum":0},"weight":{"description":"Peso unitário * quantidade em Kg","type":"number","minimum":0},"size":{"description":"Package size","type":"string","enum":["xs","s","m","l","xl"]},"price":{"description":"Preço unitário * quantidade na moeda da empresa","type":"number","minimum":0}}}},"Unauthenticated":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/routes/{id}":{"get":{"tags":["Routes"],"summary":"Consulta de rota","description":"Recuperar dados de uma rota.","responses":{"200":{"description":"Operação bem-sucedida","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getRoute/successfullResponse"}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthenticated"}}}}},"parameters":[{"name":"id","in":"path","description":"Identifier of the route to query.","required":true,"schema":{"type":"string"}}]}}}}
```