API de Depósitos
En Optiroute los depósitos corresponden a los puntos de partida y término de las rutas. Las rutas configuradas como abiertas no tienen depósito de finalización.
La API de depósitos de Optiroute permite administrarlos desde tu sistema a través del siguiente endpoint:
https://testing.optiroute.cl/api/v1/warehouses/
Estados de depósitos
Los depósitos tienen los siguientes estados:
Nombre del estado | Número de estado | Descripción |
DISABLED | -1 | El depósito fue eliminado |
ENTERED | 0 | El depósito fue creado |
Objetos
Para interactuar con este endpoint se deben utilizar las estructuras de datos que se describirán a continuación.
Objeto comuna de respuesta
El objeto comuna de respuesta es un hash de cada comuna y su nombre.
Propiedad | Tipo | Descripción |
name | Texto | Nombre de la comuna |
Objeto dirección de respuesta
El objeto dirección de respuesta es un hash de cada dirección y sus propiedades, donde la clave es su propiedad id, que corresponde al Identificador único del pedido en Optiroute.
Propiedad | Tipo | Descripción |
id | Número | Identificador único de la dirección provisto por Optiroute |
commune | Objeto comuna de respuesta | Comuna de la dirección |
full_address | Texto | Versión extendida de la dirección |
short_address | Texto | Versión resumida de la dirección |
street_name | Texto | Nombre de la calle de la dirección |
apartment_number | Texto | Número de departamento de la dirección |
address_number | Texto | Numeración de la dirección |
sub_locality | Texto | Sublocalidad de la dirección |
locality | Texto | Localidad de la dirección |
postal_code | Texto | Código postal de la dirección |
latitude | Flotante | Latitud de la coordenada geográfica de la dirección |
longitude | Flotante | Longitud de la coordenada geográfica de la dirección |
Objeto depósito de respuesta
El objeto depósito de respuesta es un hash de cada depósito y sus propiedades, donde la clave es su propiedad id, que corresponde al Identificador único del depósito en Optiroute.
Propiedad | Tipo | Descripción |
id | Número | Identificador único del depósito provisto por Optiroute |
name | Texto | Nombre del depósito |
address | Objeto dirección de respuesta | Dirección del depósito |
Acciones
A continuación se describen las acciones para administrar los depósitos.
Obtener lista de depósitos
Para obtener la lista de depósitos desde Optiroute debes realizar una llamada tipo GET al endpoint de la API de depósitos.
Obtener depósito particular
Para obtener el detalle de un depósito desde Optiroute debes realizar una llamada tipo GET en el endpoint de la API de depósitos agregando su id al final de la URL, de la siguiente manera:
https://testing.optiroute.cl/api/v1/warehouses/{id}/
Si la llamada fue realizada correctamente la API deberá retornar un objeto de tipo depósito de respuesta.