Criar rota

Este processo é assíncrono, você pode entrar no sistema para ver seu progresso ou a rota criada.

Criação de rotas

Endpoint que permite criar rotas a partir de entregas dadas.

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

Authorization

Basic_Auth

Body

application/json

Aqui vai a descrição.

routes*array of object

Conjunto de entregas, cada item cria uma rota.

iterations*integer

Indica o nível de otimização com que se criará a rota.

Example: 1

Response

200401

Operação bem sucedida.

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Processo criado com sucesso"

dataobject

Informaçãp dos processos adicionais criados (no caso em que a entrega pertença à uma rota)

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": "Processo criado com sucesso",
  "data": {
    "jobs": "JOB-1234"
  }
}

Casos de uso

Criar rota com uma ordem específica de entrega

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

Criar rotas com otimização média a partir de entregas inseridas

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

Criar rotas com otimização alta a partir de entregas inseridas.

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