Skip to main content
En esta guía, te explicaremos paso a paso cómo crear un envío utilizando el API de every. Sigue estos pasos para integrar y automatizar tus envíos de manera eficiente.

1. Obtener tu API key

Para utilizar el API de every, primero necesitas obtener tu clave de API (api-key). Debes solicitar esta clave a tu asesor de every. Mantén esta clave segura, ya que permite el acceso completo a tu cuenta.

2. Obtener la lista de ciudades

Antes de crear un envío, necesitas conocer las ciudades que cubre every. Consulta la lista de ciudades para asegurarte de que tu destino está cubierto. Encuentra la documentación del endpoint aquí.

3. Crear una nueva cotización

Una vez que tengas la lista de ciudades, puedes proceder a crear una cotización para el envío. Este paso te permitirá obtener una tarifa estimada para el envío basado en el origen, destino, peso, dimensiones y valor declarado del paquete.
El proceso de cotización en every es asíncrono. Una vez que creas una cotización, esta generará una lista de ofertas de cada empresa transportadora en estado PENDING. Deberás consultar periódicamente la cotización hasta que la oferta que te interese pase a estado SUCCESS o FAILED. En el caso de que pase a SUCCESS, ya puedes obtener los valores de la cotización.
Este es un ejemplo de la petición que debes enviar al endpoint de creación de cotización. En este ejemplo el valor declarado del paquete es COP 45.000 y se van a recaudar COP 89.000 contra entrega.
{
  "origin": "locations/CO-05001000",
  "destination": "locations/CO-11001000",
  "package": {
      "declaredValueCents": 4500000,
      "dimensions": {
          "lengthCm": 10,
          "widthCm": 20,
          "heightCm": 15
      },
      "weightKg": 2,
      "contentDescription": "Shoes"
  },
  "cashOnDeliveryRequestCents": 8900000
}
Recuerda que los valores monetarios se especifican en centavos. Por ejemplo, para recaudar 20.000 pesos, se debe ingresar 2000000. Los valores retornados por el servicio también están en centavos.
Para crear una cotización debes usar este endpoint y luego para consultarla hasta que la oferta que te interese haya sido completada, debes usar este endpoint.

4. Consultar la lista de orígenes

En every, un origen se refiere al lugar desde donde se envían los paquetes y al cual se retornarán en caso de devolución. Este puede ser, por ejemplo, tu tienda o almacén principal. Antes de poder realizar envíos, es necesario que tengas al menos un origen. Para crear tu primer origen, comunícate con tu asesor de every. Para saber desde dónde puedes despachar tus envíos, necesitas consultar la lista de orígenes disponibles. Esto te ayudará a seleccionar el punto de partida más adecuado para tu envío. Encuentra la documentación del endpoint aquí.

5. Crear un envío

Con la cotización y el origen ya definidos, puedes crear un envío. En este paso, deberás especificar la cotización obtenida y el origen desde donde se va a enviar, junto con los detalles del destinatario y del paquete.
El proceso de creación de envíos en every también es asíncrono. Cuando un envío es creado, iniciará en estado GENERATING_LABEL. Luego, pasará a estado LABEL_GENERATED si no se solicitó una recogida, a SCHEDULED_PICKUP si se solicitó una recogida, o a WITH_ERROR si ocurrió un error generando la guía.
Encuentra la documentación del endpoint aquí.

6. Consultar el envío creado

Finalmente, para verificar los detalles del envío y obtener la guía, puedes consultar el envío creado. Este paso te permitirá obtener toda la información necesaria para el seguimiento del envío. Encuentra la documentación del endpoint aquí.

Soporte

Para dudas adicionales, comunícate con tu asesor de every, quien estará disponible para ayudarte con cualquier pregunta o problema que puedas tener.