Get route information

You can retrieve a route by its ID or by any delivery ID belonging to the route

Route inquiry

Retrieve data for a route.

GEThttps://api.shippify.co/v1/routes/{id}

Authorization

Basic_Auth

Path parameters

id*string

Identifier of the route to query.

Response

200401

Successful operation

Body

application/json

payloadobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.shippify.co/v1/routes/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200401

{
  "payload": {
    "route": {
      "id": "r-shiinc-27946",
      "city": {
        "id": "3",
        "name": "Santiago de Chile"
      },
      "deliveries": [
        {
          "id": "t-shiinc-27946",
          "referenceId": "PO-00012",
          "state": 3,
          "status": "assigned",
          "company": {
            "id": 2,
            "name": "TextLam"
          },
          "pickup": {
            "location": {
              "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
              "instructions": "Unit 1001",
              "lat": -33.511333999,
              "lng": -70.6102933
            },
            "timeWindow": {
              "start": "2023-10-27T18:24:11.000Z",
              "end": "2023-10-27T18:54:11.000Z"
            },
            "contact": {
              "name": "Iliana Bolaños",
              "email": "[e-mail]",
              "phonenumber": "0998976565"
            }
          },
          "dropoff": {
            "location": {
              "address": "Vicuna Mackenna 6100, La Florida, Region Metropolitana, Chile",
              "instructions": "Unit 1001",
              "lat": -33.511333999,
              "lng": -70.6102933
            },
            "timeWindow": {
              "start": "2023-10-27T19:24:11.000Z",
              "end": "2023-10-27T19:54:11.000Z"
            },
            "contact": {
              "name": "Iliana Bolaños",
              "email": "[e-mail]",
              "phonenumber": "0998976565"
            }
          },
          "fare": {
            "service": 3.2,
            "cash": 10,
            "currencyCode": "CLP"
          },
          "packages": {
            "capacity": 2,
            "contents": [
              {
                "id": "Product-001",
                "name": "Color box",
                "qty": 4,
                "weight": 5.3,
                "size": "flex",
                "price": 5.3
              }
            ]
          },
          "tags": [
            "Delicate"
          ],
          "receiver": {
            "name": "Iliana Bolaños",
            "email": "[e-mail]",
            "phonenumber": "0998976565"
          },
          "chargedDistance": 10.4,
          "routeDistance": 10.4,
          "deliveryType": "slot",
          "jobId": "JOB-1234"
        }
      ],
      "status": "assigned",
      "minimumCapacity": 2,
      "stepIds": [
        {
          "deliveryId": "t-pruaas-4973",
          "activityType": "pickup"
        }
      ]
    }
  }
}