Listado de Oficinas por transportador
Esta API permite consultar los puntos de venta y oficinas de una transportadora específica. Está diseñada para permitir búsquedas globales (a nivel nacional) o filtradas por ciudad, nombre y dirección.
Autenticación
El acceso requiere un JWT (JSON Web Token) válido firmado por Aveonline en las cabeceras:
- Authorization:
Bearer <tu_token_jwt>
Transportadoras Disponibles
Para el parámetro operador, puede utilizar tanto el nombre como el código (ID) de la transportadora:
| Transportadora | Nombre (Slug) | Código (ID) |
|---|---|---|
| Coordinadora | coordinadora | 1009 |
| Interrapidisimo | inter | 1016 |
| Servientrega | servientrega | 33 |
Endpoint de Consulta
Método: GET
URL: https://api.aveonline.co/api-oficinas/public/api/v1/offices/all
Parámetros de Consulta (Query Parameters)
| Parámetro | Requerido | Tipo | Descripción |
|---|---|---|---|
operador | SÍ | string | Nombre o Código ID de la transportadora (ej. inter o 1016). |
ciudad | No | string | Código DANE 8 posiciones. |
nombre | No | string | Filtro de búsqueda parcial por nombre del punto de venta. |
direccion | No | string | Filtro de búsqueda parcial sobre la dirección física. |
Ejemplos de Consulta
Consulta nacional por transportadora
GET https://api.aveonline.co/api-oficinas/public/api/v1/offices/all?operador=coordinadora
Consulta por ciudad
GET https://api.aveonline.co/api-oficinas/public/api/v1/offices/all?operador=coordinadora&ciudad=05001000
Consulta por ciudad y nombre
GET https://api.aveonline.co/api-oficinas/public/api/v1/offices/all?operador=inter&ciudad=11001000&nombre=principal
Consulta por ciudad y dirección
GET https://api.aveonline.co/api-oficinas/public/api/v1/offices/all?operador=servientrega&ciudad=76001000&direccion=calle
Consulta usando el código ID del operador
GET https://api.aveonline.co/api-oficinas/public/api/v1/offices/all?operador=1009&ciudad=05001000
Los parámetros se envían por query string en la URL.
Ejemplo correcto:?operador=coordinadora&ciudad=05001000
Respuesta Exitosa (200 OK)
La API retorna un campo operadores (un arreglo) que contiene el nombre del operador y su listado de oficinas normalizadas.
{
"status": "success",
"operadores": [
{
"nombre": "inter",
"oficinas": [
{
"nombre": "CENTRO DE SERVICIO PRINCIPAL",
"direccion": "AV CALLE 26 # 69-76",
"ciudad": "BOGOTA"
}
]
}
]
}
Descripción de campos de Respuesta
Objeto Principal
status: (string) Estado de la petición (successoerror).operadores: (array) Lista de transportadoras consultadas.
Detalle de Oficinas
nombre: (string) Nombre comercial o identificado del punto de venta.direccion: (string) Dirección física de la oficina.ciudad: (string) Nombre de la ciudad o localidad donde se ubica el punto.
Respuestas de Error
| Código | Mensaje | Razón |
|---|---|---|
| 401 | Token invalido o expirado | El token JWT no fue proporcionado, es inválido o ya caducó. |
| 400 | El parámetro operador es obligatorio. | No se especificó el operador en la petición (parámetro operador vacío). |
| 404 | No se encontraron oficinas o puntos de venta. | La búsqueda con los filtros aplicados no arrojó resultados. |