Introducción
API Endpoint
https://apirest.logictracker.com/
La API de LOGICTRACKER proporciona acceso programático para leer y actualizar datos de sus principales entidades de negocio.
Para utilizar nuestra API, el cliente necesitará 2 datos fundamentales: IdEmpresa y HashApi . Contáctenos en soporte@logictracker.com para obtener sus credenciales y comenzar a utilizar nuestra API.
Get Routes
# Ejemplo Request HTTP
POST /api/Routes/GetRoutes HTTP/1.1
Host: apirest.logictracker.com
Content-Type: application/json
{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API"
}
# Ejemplo Request CURL
curl --location --request POST 'https://apirest.logictracker.com/api/Routes/GetRoutes' \
--header 'Content-Type: application/json' \
--data-raw '{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API"
}'
Para obtener las rutas del dia, debe realizar una llamada POST a la siguiente URL:
https://apirest.logictracker.com/api/Routes/GetRoutes
# Ejemplo API Respuesta
{
"response": {
"codigo": 200,
"mensaje": "OK",
"id": 0
},
"routes": [
{
"code": "20200825-AST124-87864",
"status": 9,
"statusDescription": "VIAJE_STATE_CERRADO",
"jobs": [
{
"customerName": null,
"customerCode": "7797010018",
"customerDescription": "CENCOSUD SA",
"customerDeliveryDays": null,
"customerCity": "",
"customerServiceTimeWindow": null,
"customerPhone": "",
"customerManager": null,
"customerLocation": {
"code": "7797010018",
"description": "CENCOSUD SA",
"latitude": -34.4455261,
"longitude": -58.8696861
},
"priorityOrder": 1,
"stateId": 9,
"stateDescription": "ENTREGA_STATE_COMPLETADO",
"stateDateTime": "",
"shipments": null,
"scheduledSince": "28/8/2020 15:18:40",
"scheduledUntil": "28/8/2020 15:18:40",
"comment": " ",
"jobType": "PICKUP",
"packages": 0,
"totalPackages": 0
},
{
"customerName": null,
"customerCode": "1",
"customerDescription": "INC SA",
"customerDeliveryDays": null,
"customerCity": "",
"customerServiceTimeWindow": null,
"customerPhone": null,
"customerManager": null,
"customerLocation": {
"code": "1",
"description": "INC SA",
"latitude": -34.5234375,
"longitude": -58.75428
},
"priorityOrder": 2,
"stateId": 9,
"stateDescription": "ENTREGA_STATE_COMPLETADO",
"stateDateTime": "",
"shipments": [
{
"code": "200",
"supplies": [
{
"code": "G",
"description": "Generico",
"comment": null,
"quantity": 1,
"price": "0",
"weight": 0,
"volume": 0
}
],
"comment": null,
"shipmentImages": null
}
],
"scheduledSince": "28/8/2020 16:38:40",
"scheduledUntil": "28/8/2020 16:38:40",
"comment": " ",
"jobType": "DELIVERY",
"packages": 0,
"totalPackages": 0
}
]
}
]
}
REQUEST BODY PARAMETERS
| Nombre |
Tipo |
Descripción |
| IdEmpresa |
Int |
Será un ID único provisto por Logictracker para el cliente que consulta la API. |
| HashApi |
String |
Será un HASH único provisto por Logictracker para el cliente que consulta la API. |
RESPONSE PARAMETERS
| Nombre |
Tipo |
Descripción |
| response |
GenericResponse |
Objeto que indica una respuesta generica de la API. |
| routes |
List<RouteApi> |
Lista de rutas del dia. |
GENERIC RESPONSE PARAMETERS
| Nombre |
Tipo |
Descripción |
| codigo |
Int |
Código respuesta de la API. |
| mensaje |
String |
Mensaje que describe la respuesta de la API. |
| id |
Int |
En caso de generar el alta de una entidad, la API puede devolver el ID de la entidad creada. |
ROUTE API PARAMETERS
| Nombre |
Tipo |
Descripción |
| code |
String |
Código de identificación de la ruta. |
| status |
Int |
Número que identifica el estado de la ruta. |
| statusDescription |
String |
Descripción del estado de la ruta. |
| date |
String |
Fecha y hora de la ruta. |
| licensePlate |
String |
Patente del vehiculo de la ruta. |
| carrierCode |
String |
Código del transportista de la ruta. |
| carrierDescription |
String |
Descripción del transportista de la ruta. |
| costCenterCode |
String |
Código del centro de costos de la ruta. |
| costCenterDescription |
String |
Descripción del centro de costos de la ruta. |
| baseCode |
String |
Código de la base de la ruta. |
| baseDescription |
String |
Descripción de la base de la ruta. |
| driverId |
String |
Legajo del chofer de la ruta. |
| jobs |
List<JobApi> |
Lista de clientes que se tienen que visitar en la ruta. |
JOB API PARAMETERS
| Nombre |
Tipo |
Descripción |
| customerName |
String |
Nombre del cliente. |
| customerCode |
String |
Código del cliente. |
| customerDescription |
String |
Descripción del cliente. |
| CustomerDeliveryDays |
String |
Días en los que el cliente recibe mercadería. |
| customerCity |
String |
Ciudad del cliente. |
| customerServiceTimeWindow |
String |
Ventana horaria en que el cliente recibe mercadería. |
| customerPhone |
String |
Número de teléfono del cliente. |
| customerManager |
CustomerManager |
Objeto que representa los datos del supervisor o responsable del cliente. |
| customerLocation |
Location |
Objeto que representa la ubicación geográfica del cliente. |
| priorityOrder |
Int |
Orden de prioridad del cliente en la ruta. |
| stateId |
Int |
Id del estado del cliente en la ruta. |
| stateDescription |
String |
Descripción del estado del cliente en la ruta. |
| stateDateTime |
String |
Fecha y hora en que fue gestionado el estado del cliente. |
| shipments |
List<Shipment> |
Lista de remitos que tiene el cliente. |
| scheduledSince |
String |
Horario programado DESDE del cliente. |
| scheduledUntil |
String |
Horario programado HASTA del cliente. |
| comment |
String |
Comentario del cliente. |
| jobType |
String |
Tipo/rol que cumple el cliente en la ruta. |
| packages |
Int |
Bultos del envio. |
| totalPackages |
Int |
Bultos totales del envio. |
CUSTOMER MANAGER PARAMETERS
| Nombre |
Tipo |
Descripción |
| name |
String |
Nombre del responsable/supervisor del cliente. |
| phone |
String |
Teléfono del responsable/supervisor del cliente. |
| typeManager |
String |
Tipo/rol del responsable del cliente. |
LOCATION PARAMETERS
| Nombre |
Tipo |
Descripción |
| code |
String |
Código de la ubicación. |
| description |
String |
Descripción de la ubicación. |
| latitude |
Float |
Latitud de la ubicación. |
| longitude |
Float |
Longitud de la ubicación. |
SHIPMENT PARAMETERS
| Nombre |
Tipo |
Descripción |
| code |
String |
Código del remito. |
| supplies |
List<Supplie> |
Listado de productos del remito. |
| comment |
String |
Comentario del remito. |
| shipmentImages |
List<ShipmentImage> |
Listado de imágenes del remito. |
SUPPLIE PARAMETERS
| Nombre |
Tipo |
Descripción |
| code |
String |
Código del producto. |
| description |
String |
Descripción del producto. |
| comment |
String |
Comentario del producto. |
| quantity |
Int |
Cantidad de productos. |
| price |
String |
Precio del producto. |
| weight |
float |
Peso del producto. |
| volume |
String |
Volumen del producto. |
SHIPMENT IMAGE PARAMETERS
| Nombre |
Tipo |
Descripción |
| url |
String |
Url de la imagen. |
Errors
La llama a la API de Routes/GetRoutes puede devolver los siguientes códigos de error dentro del objeto GenericResponse
| Código |
Mensaje |
| 200 |
OK
|
| 400 |
Request sin contenido en body, body request null.
|
| 401 |
Consulta sin id de empresa/hash. Asegurese de incluir en su request idEmpresa y hashApi provisto por LOGICTRACKER.
|
| 402 |
Empresa no habilitada para consultar get routes. Solicitar habilitación uso de API a LOGICTRACKER.
|
| 403 |
Hash invalido para consultar API. Asegurese que hashApi provisto por LOGICTRACKER sea el correcto.
|
| 500 |
Excepcion en api/Routes/GetRoutes. Entre en contacto con el area de sistemas de LOGICTRACKER y envie el CONTENIDO DEL REQUEST para ser analizado.
|
