Create route

This process is asynchronous. You can log into the system to check its progress or the route created.

Route creation

Endpoint that allows creating routes from given deliveries.

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

Authorization

Basic_Auth

Body

application/json

Here goes the description

routes*array of object

Set of deliveries, each item will create a route

iterations*integer

Indicates the level of optimization with which the route will be created

Example: 1

Response

200401

Successful operation

Body

application/json

codestring

Example: "OK"

messagestring

Example: "Process created successfully"

dataobject

Information of the additional processes created (in case the delivery belongs to a route)

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": "Process created successfully",
  "data": {
    "jobs": "JOB-1234"
  }
}

Use cases

Create routes with a specific order of deliveries

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

Create routes with medium optimization based on entered deliveries

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

Create routes with high optimization based on entered deliveries

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