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.

post

/v1/routes/create

Authorizations

Body

iterationsinteger · min: 1 · max: 10required

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

Example: 1

routesobject[]required

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 '{
    "iterations": 1,
    "routes": [
      {
        "deliveries": [
          "t-pruaas-4973"
        ]
      }
    ]
  }'

200

401

200

{
  "code": "OK",
  "message": "Process created successfully",
  "data": {
    "jobs": "JOB-1234"
  }
}

Successful operation

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
}