Saltar al contenido principal

Cobertura por Código Postal

Obtiene la sucursal destino correspondiente a un código postal. Útil para autocompletar el DestinoCode antes de crear guías.

GET /api/sucursales/cobertura/{codigoPostal}

Permiso requerido: guias.read

Parámetros

ParámetroTipoDescripción
codigoPostalstringCódigo postal de 5 dígitos (ej: 44100)

Ejemplo

curl -X GET "https://ws-api.masaprisaoperativo.com/api/sucursales/cobertura/44100" \
-H "Authorization: Bearer {token}"

Respuesta con Cobertura

{
"response": "OK",
"message": "Código postal con cobertura",
"data": {
"codigo_postal": "44100",
"asentamiento": "Centro",
"municipio": "Guadalajara",
"estado": "Jalisco",
"tiene_cobertura": true,
"sucursal": {
"sucu_id": 12,
"sucu_sucursal": "GDLGL",
"sucu_descripcion": "GUADALAJARA GONZALES GALLO"
}
}
}

Respuesta sin Cobertura

{
"response": "OK",
"message": "Código postal válido pero sin cobertura de sucursal",
"data": {
"codigo_postal": "99999",
"asentamiento": "Colonia X",
"municipio": "Municipio Y",
"estado": "Estado Z",
"tiene_cobertura": false,
"sucursal": null
}
}

Respuesta de Error

{
"response": "ERROR",
"message": "Código postal no encontrado"
}

Uso Recomendado

  1. El usuario ingresa el código postal del destinatario
  2. Llamas a este endpoint para verificar cobertura
  3. Si tiene_cobertura es true, usas sucursal.sucu_sucursal como DestinoCode
  4. Si no tiene cobertura, muestras mensaje al usuario
const response = await fetch(`/api/sucursales/cobertura/${codigoPostal}`, {
headers: { 'Authorization': 'Bearer ' + token }
});
const data = await response.json();

if (data.data?.tiene_cobertura) {
// Usar data.data.sucursal.sucu_sucursal como DestinoCode
console.log('Sucursal:', data.data.sucursal.sucu_sucursal);
} else {
// Mostrar error: sin cobertura en ese CP
console.log('Sin cobertura');
}

:::tip Alternativa También puedes enviar solo el CodigoPostal al crear la guía y el sistema obtiene la sucursal automáticamente. Ver Crear Guía. :::