Crear ruta

Este proceso es asíncrono, puedes entrar en el sistema para ver su progreso o la ruta creada.

Creación de rutas

Endpoint que permite crear rutas apartir de entregas dadas.

POSThttps://api.shippify.co/v1/routes/create

Authorization

Basic_Auth

Body

application/json

Aqui va la descripción

routes*array of object

Conjunto de entregas, cada item creará una ruta

iterations*integer

Indica el nivel de optimización con el que se creará la ruta

Example: 1

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Proceso creado exitosamente"

dataobject

Información de los procesos adicionales creados (en el caso que la entrega pertenezca a una ruta)

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/routes/create', {
    method: 'POST',
    headers: {
      "Authorization": "basic <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "routes": [
        {
          "deliveries": [
            "t-pruaas-4973"
          ]
        }
      ],
      "iterations": 1
    }),
});
const data = await response.json();

Response

200401

{
  "code": "OK",
  "message": "Proceso creado exitosamente",
  "data": {
    "jobs": "JOB-1234"
  }
}

Casos de uso

Crear rutas con un orden específico de entregas

{
    "routes": [
        {
            "deliveries": [
              "t-pruaas-4973",
              "t-pruaas-4972"
            ]
        }
    ],
    "iterations": 1
}

Crear rutas con optimización media a partir de entregas ingresadas

{
    "routes": [
        {
            "deliveries": [
              "t-pruaas-4973",
              "t-pruaas-4972"
            ]
        }
    ],
    "iterations": 5
}

Crear rutas con optimización alta a partir de entregas ingresadas

{
    "routes": [
        {
            "deliveries": [
              "t-pruaas-4973",
              "t-pruaas-4972"
            ]
        }
    ],
    "iterations": 10
}