Create route

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

Route creation

post

Endpoint that allows creating routes from given deliveries.

Autorizaciones

Basic_Auth

AuthorizationstringRequerido

Cuerpo

application/json

iterationsinteger · mín: 1 · máx: 10Requerido

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

Example: 1

Respuestas

200

Successful operation

application/json

codestringOpcionalExample: OK

messagestringOpcionalExample: Process created successfully

401

Unauthorized

application/json

post

/v1/routes/create

HTTPcURLJavaScriptPython

POST /v1/routes/create HTTP/1.1
Host: api.shippify.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 60

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

{
  "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
}