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.

post

/v1/routes/create

Authorizations

Body

routesobject[]required

Conjunto de entregas, cada item cria uma rota.

iterationsinteger · min: 1required

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

Example: 1

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.shippify.co/v1/routes/create' \
  --header 'Authorization: Basic username:password' \
  --header 'Content-Type: application/json' \
  --data '{
    "routes": [
      {
        "deliveries": [
          "t-pruaas-4973"
        ]
      }
    ],
    "iterations": 1
  }'

200

401

200

{
  "code": "OK",
  "message": "Processo criado com sucesso",
  "data": {
    "jobs": "JOB-1234"
  }
}

Operação bem sucedida.

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
}