Mensajes comunes

No Autorizado (Unauthorized)

Status: 401

La solicitud no incluye credenciales de autenticación válidas, o las credenciales proporcionadas no son correctas.

Ejemplos:

Sin Clave de Autenticación

Si no se envía la cabecera Authorization con la clave requerida, la API devolverá el siguiente mensaje:

{
    "success": false,
    "timestamp": "2025-06-26T22:29:32+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "Token no proporcionado.",
        "details": {
            "Authorization": "Encabezado no presente"
        }
    }
}

Clave de Autenticación Inválida

Si se envía una clave no valida se informa mediante el siguiente mensaje:

{
    "success": false,
    "timestamp": "2025-06-26T22:26:35+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "Token inválido.",
        "details": {
            "token": "verificar token"
        }
    }
}

Ruta inexistente (Not Found)

Status: 404

Significa que el servidor no puede encontrar el recurso solicitado en la dirección URL proporcionada. Generalmente se debe a que que la URL se haya escrito incorrectamente.

{
    "success": false,
    "timestamp": "2025-06-28T16:24:01+00:00",
    "path": "/api/v3/public/generarguia",
    "data": {
        "message": "Ruta no encontrada."
    }
}

Método no permitido (Method Not Allowed)

Status: 405

Indica que el servidor ha recibido una solicitud con un método HTTP que no es compatible con el recurso solicitado. En otras palabras, el servidor entiende la solicitud pero no permite el método utilizado (como GET, POST, DELETE).

{
    "success": false,
    "timestamp": "2025-06-28T16:17:04+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "Método no permitido.",
        "details": {
            "metodo_usado": "GET",
            "metodos_permitidos": [
                "POST"
            ]
        }
    }
}

Petición incorrecta (Bad Request)

Status: 400

Si no se envía el Parámetro que espera el endpoint, la API devolverá el siguiente mensaje:

{
    "success": false,
    "timestamp": "2025-07-17T22:23:03+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "Parámetro inválido",
        "details": {
            "parametro": "shipper.rfc",
            "valor_esperado": "Formato RFC válido",
            "valor_recibido": "rfc"
        }
    }
}

Conflictos (Conflict)

Status: 409

Indica que la solicitud no pudo completarse debido a un conflicto con el estado actual del recurso en el servidor.

Ejemplos:

Saldo insuficiente

Cuando el saldo disponible es menor al requerido para generar una guía.

{
    "success": false,
    "timestamp": "2025-06-26T23:57:03+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "Saldo insuficiente.",
        "details": {
            "saldo": 100,
            "costo_operacion": 707.71,
            "requerido": 607.71,
            "cargos": {
                "guia": 569.71,
                "seguro": 111,
            }
        }
    }
}

Sin guías disponibles

Cuando no cuentas con guías disponibles para generar, en este caso debe especificar pagar con saldo prepago marcando el parámetro guia.saldo_prepago en on.

{
    "success": false,
    "timestamp": "2025-06-27T00:32:12+00:00",
    "path": "/api/v3/public/guia",
    "data": {
        "message": "No cuenta con guías disponibles.",
        "details": {
            "guia.tipo": 58,
            "guia.peso": 64,
            "disponibles": 0
        }
    }
}