Tipos de estados de envíos

Lista los tipos de estados de envíos homologados de AVEONLINE que se encuentran activos en el sistema, junto con su código, nombre y descripción. Es un servicio común para todas las transportadoras y permite, por ejemplo, interpretar el estado_id que llega en el Webhook estados de la guía.

Importante

Para consumir este servicio el cliente debe estar autenticado. El token se obtiene en Autenticación y se envía en el header Authorization sin el prefijo Bearer.

Request

url

https://envios.api.aveonline.co/api/v1/states/types

Method

GET

Header

Content-Type: application/json
Authorization: {token}

Response

Success

• status String Estado del resultado
• message String Mensaje de respuesta
• data Array Object -> [{}]
  • code String Código del estado del envío homologado de AVE
  • name String Nombre del estado
  • description String Descripción del estado

Ejemplo

{
  "status": "ok",
  "message": "Data found",
  "data": [
    {
      "code": "3",
      "name": "Entregada",
      "description": "El envío fue entregado satisfactoriamente al destinatario."
    },
    {
      "code": "2",
      "name": "En reparto",
      "description": "El envío se encuentra en ruta de entrega al destinatario."
    }
  ]
}

Token inexistente o inválido

{
  "errors": [
    {
      "title": "Error control",
      "detail": "Token does not exist"
    }
  ]
}