Home

Introduction

Route Planner API

version 1

Route Planner API is a solution for carriers to provide accurate tracking by sea, land, and air. Create detailed routes, add custom events, and assign unique shipment IDs for extended tracking capabilities.

OpenAPI Specification

Start designing your API in minutes. The OpenAPI specification file enables you to learn and interact with API elements, including all available endpoints, input and output representations.

OpenAPI Spec

General information

Route Planner API is organized around REST.
Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API endpoint#

1https://routeplanner.searates.com

All endpoints are only accessible via HTTPS and are located at routeplanner.searates.com

Get a list of your routes

get/routes

Get a list of your routes

Headers

Content-Typeapplication/json

Query Parameters
  • api_keyREQUIREDstring

    Your api key. If you do not have an api key - contact us to purchase a subscription.

Response example
Get a list of your routes.
1{
2  "status_code": "OK",
3  "data": [
4    {
5      "number": "RP-JF87XKID",
6      "created_at": "2024-12-23 09:53:28",
7      "updated_at": "2024-12-23 09:54:42"
8    },
9    {
10      "number": "RP-7B8UZO0K",
11      "created_at": "2024-12-23 10:57:33",
12      "updated_at": "2024-12-23 10:57:33"
13    }
14  ]
15}

Create route

post/routes

Create route

Headers

Content-Typeapplication/json

Query Parameters
  • api_keyREQUIREDstring

    Your api key. If you do not have an api key - contact us to purchase a subscription.

Body Parameters
  • waypointsOptionalarray[object]
Response example
Create route.
1{
2  "status_code": "OK",
3  "data": {
4    "number": "RP-F2RQ19IK",
5    "created_at": "2024-12-26 09:55:00",
6    "updated_at": "2024-12-26 09:55:00",
7    "waypoints": [
8      {
9        "type": "SEA",
10        "description": null,
11        "name": "Izmir",
12        "state": null,
13        "country": null,
14        "country_code": "TR",
15        "locode": "TRIZM",
16        "lat": 38.41273,
17        "lng": 27.13838,
18        "events": [
19          {
20            "description": "Load",
21            "datetime": "2024-11-23 13:37:00",
22            "vessel": "MAERSK VALPARAISO",
23            "voyage": "447S"
24          },
25          {
26            "description": "Vessel departure",
27            "datetime": "2024-11-23 19:21:00",
28            "vessel": "MAERSK VALPARAISO",
29            "voyage": "447S"
30          }
31        ],
32        "transport_mode_to_next": "SEA",
33        "path_to_next": []
34      },
35      {
36        "type": "SEA",
37        "description": null,
38        "name": "Port Said East",
39        "state": null,
40        "country": null,
41        "country_code": "EG",
42        "locode": "EGPSE",
43        "lat": 31.216666666667,
44        "lng": 32.35,
45        "events": [
46          {
47            "description": "Vessel arrival",
48            "datetime": "2024-11-27 14:33:00",
49            "vessel": "MAERSK VALPARAISO",
50            "voyage": "447S"
51          }
52        ],
53        "transport_mode_to_next": null,
54        "path_to_next": []
55      }
56    ]
57  }
58}

Get route data

get/routes/{routeNumber}

Get route data

Headers

Content-Typeapplication/json

Path Parameters
  • routeNumberREQUIREDstring

    Route number.

    Example:RP-F2RQ19IK

Query Parameters
  • api_keyREQUIREDstring

    Your api key. If you do not have an api key - contact us to purchase a subscription.

Response example
Get route data.
1{
2  "status_code": "OK",
3  "data": {
4    "number": "RP-F2RQ19IK",
5    "created_at": "2024-12-26 09:55:00",
6    "updated_at": "2024-12-26 09:55:00",
7    "waypoints": [
8      {
9        "type": "SEA",
10        "description": null,
11        "name": "Izmir",
12        "state": null,
13        "country": null,
14        "country_code": "TR",
15        "locode": "TRIZM",
16        "lat": 38.41273,
17        "lng": 27.13838,
18        "events": [
19          {
20            "description": "Load",
21            "datetime": "2024-11-23 13:37:00",
22            "vessel": "MAERSK VALPARAISO",
23            "voyage": "447S"
24          },
25          {
26            "description": "Vessel departure",
27            "datetime": "2024-11-23 19:21:00",
28            "vessel": "MAERSK VALPARAISO",
29            "voyage": "447S"
30          }
31        ],
32        "transport_mode_to_next": "SEA",
33        "path_to_next": []
34      },
35      {
36        "type": "SEA",
37        "description": null,
38        "name": "Port Said East",
39        "state": null,
40        "country": null,
41        "country_code": "EG",
42        "locode": "EGPSE",
43        "lat": 31.216666666667,
44        "lng": 32.35,
45        "events": [
46          {
47            "description": "Vessel arrival",
48            "datetime": "2024-11-27 14:33:00",
49            "vessel": "MAERSK VALPARAISO",
50            "voyage": "447S"
51          }
52        ],
53        "transport_mode_to_next": null,
54        "path_to_next": []
55      }
56    ]
57  }
58}

Update route

put/routes/{routeNumber}

Update route

Headers

Content-Typeapplication/json

Path Parameters
  • routeNumberREQUIREDstring

    Route number.

    Example:RP-F2RQ19IK

Query Parameters
  • api_keyREQUIREDstring

    Your api key. If you do not have an api key - contact us to purchase a subscription.

Body Parameters
  • waypointsOptionalarray[object]
Response example
Update route.
1{
2  "status_code": "OK",
3  "data": {
4    "number": "RP-F2RQ19IK",
5    "created_at": "2024-12-26 09:55:00",
6    "updated_at": "2024-12-27 10:43:12",
7    "waypoints": [
8      {
9        "type": "SEA",
10        "description": null,
11        "name": "Izmir",
12        "state": null,
13        "country": null,
14        "country_code": "TR",
15        "locode": "TRIZM",
16        "lat": 38.41273,
17        "lng": 27.13838,
18        "events": [
19          {
20            "description": "Load",
21            "datetime": "2024-11-23 13:37:00",
22            "vessel": "MAERSK VALPARAISO",
23            "voyage": "447S"
24          },
25          {
26            "description": "Vessel departure",
27            "datetime": "2024-11-23 19:21:00",
28            "vessel": "MAERSK VALPARAISO",
29            "voyage": "447S"
30          }
31        ],
32        "transport_mode_to_next": "SEA",
33        "path_to_next": []
34      },
35      {
36        "type": "SEA",
37        "description": null,
38        "name": "Port Said East",
39        "state": null,
40        "country": null,
41        "country_code": "EG",
42        "locode": "EGPSE",
43        "lat": 31.216666666667,
44        "lng": 32.35,
45        "events": [
46          {
47            "description": "Vessel arrival",
48            "datetime": "2024-11-27 14:33:00",
49            "vessel": "MAERSK VALPARAISO",
50            "voyage": "447S"
51          }
52        ],
53        "transport_mode_to_next": null,
54        "path_to_next": []
55      }
56    ]
57  }
58}

Delete route

delete/routes/{routeNumber}

Delete route

Headers

Content-Typeapplication/json

Path Parameters
  • routeNumberREQUIREDstring

    Route number.

    Example:RP-F2RQ19IK

Query Parameters
  • api_keyREQUIREDstring

    Your api key. If you do not have an api key - contact us to purchase a subscription.

Response example
Delete route.
1{
2  "status_code": "OK",
3  "data": {}
4}
SeaRates 2024—Find a toolRequest an IT quoteContact us