Locaciones
Un corporate API partner puede tener varias locaciones de origen almacenadas, como tiendas, almacenes, despachos, etc. Para facilitar la creación de cotizaciones, un corporate API partner puede enviar un ID de tienda para crear una cotización.
Documentación de la API para get-fare-estimates-shipments
Este documento detalla cómo crear locaciones de tienda y gestionarlas.
Crear locación
Permite crear una locación de origen para un corporate API partner.
Endpoint:
URL: baseURL/V2/corporate-api-partner/locations
Método: POST
Body payload (ejemplo):
{
"location_id": "x6",
"location_name": "Tienda x6",
"location_address": "Al lado de la parada de bus",
"location_latitude": 10.45,
"location_longitude": -66.87
}
Campo | Descripción | Tipo de dato | Validaciones | Ejemplo |
---|---|---|---|---|
location_id | Identificador único para la ubicación | Cadena de texto (string) | - Longitud mínima: 1 - Longitud máxima: 50 - Requerido | "x6" |
location_name | Nombre de la ubicación | Cadena de texto (string) | - Longitud mínima: 3 - Longitud máxima: 150 - Requerido | "Mi tiendita 2" |
location_address | Dirección de la ubicación | Cadena de texto (string) | - Longitud mínima: 3 - Longitud máxima: 350 - Requerido | "Al lado de la parada de bus" |
location_latitude | Latitud geográfica de la ubicación | Número decimal (float) | - Mínimo: -90 - Máximo: 90 - Precisión: hasta 2 decimales - Requerido | 10.45 |
location_longitude | Longitud geográfica de la ubicación | Número decimal (float) | - Mínimo: -180 - Máximo: 180 - Precisión: hasta 2 decimales - Requerido | -66.87 |
Obtener locaciones
Permite obtener las locaciones de origen para un corporate API partner.
Endpoint:
URL: baseURL/V2/corporate-api-partner/locations
Método: GET
Respuesta típica:
success: true,
data: {
locations: [
{
// Detalle de una locación
}
]
}
Obtener locación
Permite obtener las locaciones de origen para un corporate API partner.
Endpoint:
URL: baseURL/V2/corporate-api-partner/locations/:location_id
Método: GET
TIP
:location_id es el id de una locación
Respuesta típica:
success: true,
data: {
// Detalle de una locación
}
Actualizar una locación
Permite obtener las locaciones de origen para un corporate API partner.
Endpoint:
URL: baseURL/V2/corporate-api-partner/locations/:location_id
Método: PATCH
Body payload (ejemplo):
{
"location_id": "x6",
"location_name": "Tienda x6",
"location_address": "Al lado de la parada de bus",
"location_latitude": 10.45,
"location_longitude": -66.87
}
TIP
:location_id es el id de una locación
Respuesta típica:
success: true,
data: {
// Detalle de una locación actualizada
}