概要
Zeo ルート プランナーは、フリート所有者がドライバーのルートを作成および最適化するのに役立ちます。 地元のラストワンマイル配送を行う車両所有者や中小企業は、配送状況やドライバーの現在地を追跡し、リアルタイムの最新情報を顧客に送信できます。 Zeo の配達ドライバー向けモバイル アプリには、waze、tomtom、Google マップなどの一般的なナビゲーション ツールすべてとのシームレスな統合が装備されています。ドライバーは、メモ、顧客の詳細、荷物数などの重要な詳細情報をすべて指先で確認できます。 Zeo は動的なアドレスの追加と削除を処理し、シーケンスを再ルーティングして最も最適化されたルートを提供します。 Zeo のフリート所有者は、ドライバー 200 人あたり月額最大 XNUMX ドルを節約し、配達証明、署名、配達タイムスタンプなどの高品質レポートにアクセスできます。
認証
ZeoRoutePlanner は API キーを使用して API へのアクセスを許可します。 新しい API キーをプラットフォームで登録できます (https://zeorouteplanner.com/app/team/settings/genrate-token).
ZeoRoutePlanner は、API キーが次のようなパラメータでサーバーへのすべての API リクエストに含まれることを期待します。
api_key: api_key
店主アピさん
ストップの作成
curl --location --request POST '{{base_url}}/api/v5/route_stop' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key": "api_key",
"stops": [
{
"address": "Gwalior Madhaya Predesh",
"latitude": 0,
"longitude": 0.0,
"notes": "dsf",
"optimize_status": "normal",
"stop_duration": 5,
"stop_date": "2022-03-10",
"parcel_count": 2,
"arrive_start": "now",
"arrive_end": "anytime",
"earliest": 0,
"latest": 0,
"driver_id": "",
"stop_type": "delivery",
"customer_name": "nishu",
"customer_mobile_number": "+911234567890",
"customer_email": "",
"metadata": [{}]
}
]
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Stops added successfully"
}
このエンドポイントはすべてのドライバーを取得します。
HTTPリクエスト
POST {{base_url}}/api/v5/route_stop
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| 停止する | [{}] | ストップアレイ |
停止オブジェクトパラメータ
| デフォルト | 説明 | |
|---|---|---|
| 住所 | "" | 停止アドレス |
| 緯度 | "" | 住所の緯度 |
| 経度 | "" | 住所の経度 |
| ノート | "" | 追加するメッセージ |
| 最適化ステータス | "正常" | |
| stop_duration | 「停車中に留まってください」 | |
| 到着_開始 | "" | "今" |
| 到着_終了 | "" | "いつでも" |
| 早い | "" | |
| 最新の | "" | |
| 停止タイプ | "" | （配送・引き取り） |
| 顧客名 | "" | 顧客名 |
| customer_mobile_number | "" | お客様連絡先番号 |
| ドライバーID | "" | ドライバーID |
| 停止日 | "" | 停止日 |
| 小包数 | 1 | 小包数 |
| [] | カスタムフィールド |
すべてのドライバーを取得する
curl --location -g --request GET '{{base_url}}/api/v5/drivers?api_key=api_key'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"drivers": [
{
"id": 44914,
"email": "0f12ebdd@gmail.com",
"name": "nishu jain",
"address": null,
"phone_no": "8959294300",
"active": true
}
]
}
}
このエンドポイントはすべてのドライバーを取得します。
HTTPリクエスト
GET {{base_url}}/api/v5/drivers
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
ドライバーの作成
curl --location -g --request POST '{{base_url}}/api/v5/drivers' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key": "api_key",
"email": "nishu.jain396@gmail.com",
"address": "Netaji Subhash Marg, Lal Qila, Chandni Chowk, New Delhi, Delhi 110006",
"password": "12345678",
"name": "nishu jain",
"phone_no": " "
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Driver created successfully",
"data": {
"driver": {
"id": 44953,
"email": "testthird1@gmail.com",
"name": "test",
"address": "Netaji Subhash Marg, Lal Qila, Chandni Chowk, New Delhi, Delhi 110006",
"phone_no": "+918959294300",
"active": true
}
}
}
このエンドポイント作成ドライバー。
HTTPリクエスト
POST {{base_url}}/api/v5/drivers
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| "" | ドライバーのメールアドレス | |
| 住所 | "" | ドライバーのアドレス |
| password | "" | ドライバーアカウントのパスワード |
| 名 | "" | ドライバーの名前 |
| 電話番号 | "" | 連絡先番号 |
ドライバの更新
curl --location -g --request PUT '{{base_url}}/api/v5/drivers/:driver_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key": "api_key",
"name": "nishu jain",
"address": "",
"phone_no": "8959294300"
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Driver updated successfully",
"data": {
"driver": {
"id": 44953,
"name": "nishu jain",
"phone_no": "8959294300",
"address": "dlehi",
"email": "testthird1@gmail.com",
"active": true
}
}
}
このエンドポイント更新ドライバーの詳細。
HTTPリクエスト
PUT {{base_url}}/api/v5/drivers/:driver_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| 住所 | "" | ドライバーのアドレス |
| 名 | "" | ドライバーの名前 |
| 電話番号 | "" | ドライバーの連絡先番号 |
| ドライバーID | "" | すべてのドライバー API から取得したドライバー ID |
ドライバーの削除
curl --location -g --request DELETE '{{base_url}}/api/v5/drivers/:driver_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key": "api_key"
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Driver deleted successful"
}
このエンドポイントはドライバーを削除します。
HTTPリクエスト
DELETE {{base_url}}/api/v5/drivers/:driver_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ドライバーID | "" | すべてのドライバー API から取得したドライバー ID |
ルートを作成する
curl --location -g --request POST '{{base_url}}/api/v5/routes' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"start_address" : "Monroe, NC, USA",
"start_latitude" : 0.0,
"start_longitude" :0.0,
"end_address" : "Monroe, NC, USA",
"end_latitude" : 0.0,
"end_longitude" :0.0,
"route_name" : "July 2020 Roadtrip",
"driver_id": "44968",
"orginal": true,
"route_date": "",
"stops" : [
{
"address": "Gwalior Madhaya Predesh",
"latitude":106.672053,
"longitude":0.0,
"notes":"dsf",
"optimize_status":"normal",
"stop_duration":5,
"parcel_count": "",
"arrive_start":"now",
"arrive_end":"anytime",
"earliest":0,
"latest":0,
"stop_type":"delivery",
"customer_name":"nishu",
"customer_mobile_number":"+911234567890",
"metadata": [{}]
}
]
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 103110,
"start_address": "new york",
"end_address": "new york",
"start_latitude": 40.7128,
"start_longitude": 74.006,
"end_latitude": 40.7128,
"end_longitude": 74.006,
"created_at": "2021-07-21T04:07:41.000Z",
"route_name": "test",
"route_stops": [
{
"id": 222472903,
"address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"latitude": 25.9330248,
"longitude": -80.2445472,
"notes": "GOod",
"optimize_status": "normal",
"stop_duration": 10,
"customer_name": "",
"customer_mobile_number": "",
"street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
"city": "Miami-Dade County",
"state": "Florida",
"country": "Estados Unidos",
"postal_code": "33056",
"customer_email": "",
"order_number": "",
"order_status": "route_created",
"h_no": "",
"locality": ""
}
]
}
}
}
このエンドポイントはルートを作成します。
HTTPリクエスト
POST {{base_url}}/api/v5/routes
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ドライバーID | "" | すべてのドライバー API から取得したドライバー ID |
| 開始アドレス | "" | ルート開始アドレス |
| 開始緯度 | "" | 開始住所 緯度 |
| 開始経度 | "" | 開始住所経度 |
| 終了アドレス | "" | ルート終了アドレス |
| 終了緯度 | "" | 終了住所 緯度 |
| 終了_経度 | "" | 終了住所経度 |
| ルート名 | "" | 路線名 |
| ドライバーID | "" | ルートを割り当てるドライバー ID |
| 元の | "" | |
| 停止する | [] | 路線間の停車駅 |
| ルート日付 | '' | ルートの日付 |
停止オブジェクトパラメータ
| デフォルト | 説明 | |
|---|---|---|
| 住所 | "" | 停止アドレス |
| 緯度 | "" | 住所の緯度 |
| 経度 | "" | 住所の経度 |
| ノート | "" | 追加するメッセージ |
| 最適化ステータス | "正常" | |
| stop_duration | 「停車中に留まってください」 | |
| 到着_開始 | "" | "今" |
| 到着_終了 | "" | "いつでも" |
| 早い | "" | |
| 最新の | "" | |
| 停止タイプ | "" | （配送・引き取り） |
| 顧客名 | "" | 顧客名 |
| customer_mobile_number | "" | お客様連絡先番号 |
| 小包数 | 1 | 小包数 |
| [{}] | カスタムフィールド |
ルート情報を取得する
curl --location -g --request GET '{{base_url}}/api/v5/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 103110,
"start_address": "new york",
"end_address": "new york",
"start_latitude": 40.7128,
"start_longitude": 74.006,
"end_latitude": 40.7128,
"end_longitude": 74.006,
"created_at": "2021-07-21T04:07:41.000Z",
"route_name": "test",
"route_stops": [
{
"id": 222472903,
"address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"latitude": 25.9330248,
"longitude": -80.2445472,
"notes": "GOod",
"optimize_status": "normal",
"stop_duration": 10,
"customer_name": "",
"customer_mobile_number": "",
"street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
"city": "Miami-Dade County",
"state": "Florida",
"country": "Estados Unidos",
"postal_code": "33056",
"customer_email": "",
"order_number": "",
"order_status": "route_created",
"h_no": "",
"locality": ""
}
]
}
}
}
このエンドポイントはルート情報を取得します。
HTTPリクエスト
GET {{base_url}}/api/v5/routes/:route_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ルートID | "" | ルートリストから取得したルートID |
| ドライバーID | "" | ルートのドライバー ID |
ルートの最適化情報を取得する
curl --location -g --request GET '{{base_url}}/api/v5/routes/:route_id/optimize_route' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"optimized": true,
"legs": [
{
"distance": {
"text": "0 km",
"value": 0
},
"duration": {
"text": "",
"value": 0
},
"end_address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"start_address": "new york",
"start_location": {
"lat": 25.9330248,
"lng": -80.2445472
},
"end_location": {
"lat": 25.9330248,
"lng": -80.2445472
},
"stop_id": "222473116",
"optimize_status": "normal",
"stop_type": "delivery",
"arr_time": 0,
"end_time": 600,
"optimize_order": 1,
"stop_order": null,
"share_stop_id": null,
"address_typed": {},
"overview_polyline": "cah}CnwwhN"
},
{
"distance": {
"text": "0 km",
"value": 0
},
"duration": {
"text": "10 mins",
"value": 600
},
"end_address": "new york",
"start_address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"start_location": {
"lat": 25.9330248,
"lng": -80.2445472
},
"end_location": {
"lat": 25.9330248,
"lng": -80.2445472
},
"stop_id": null,
"optimize_status": "normal",
"stop_type": "normal",
"arr_time": 600,
"end_time": 0,
"optimize_order": 2,
"stop_order": 2000,
"share_stop_id": 0,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "cah}CnwwhN"
}
]
}
}
このエンドポイントはルート情報を取得します。
HTTPリクエスト
GET {{base_url}}/api/v5/routes/:route_id/optimize_route
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ドライバーID | "" | ルートのドライバー ID |
ルートを削除する
curl --location -g --request DELETE '{{base_url}}/api/v5/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Route deleted successfully"
}
このエンドポイントはルートを削除します。
HTTPリクエスト
DELETE {{base_url}}/api/v5/routes/:route_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ルートID | "" | ルートリストから取得したルートID |
| ドライバーID | "" | ルートのドライバー ID |
すべてのドライバーのルートを取得
curl --location -g --request GET '{{base_url}}/api/v5/routes' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"limit": 10,
"offset": 10,
"driver_id": "driver_id"
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"routes": [
{
"id": 103110,
"start_address": "new york",
"end_address": "new york",
"start_latitude": 40.7128,
"start_longitude": 74.006,
"end_latitude": 40.7128,
"end_longitude": 74.006,
"created_at": "2021-07-21T04:07:41.000Z",
"route_name": "test",
"route_stops": [
{
"id": 222472903,
"address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"latitude": 25.9330248,
"longitude": -80.2445472,
"notes": "GOod",
"optimize_status": "normal",
"stop_duration": 10,
"customer_name": "",
"customer_mobile_number": "",
"street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
"city": "Miami-Dade County",
"state": "Florida",
"country": "Estados Unidos",
"postal_code": "33056",
"customer_email": "",
"order_number": "",
"order_status": "route_created",
"h_no": "",
"locality": ""
}
]
}
],
"total_routes": 1
}
}
このエンドポイントはすべてのルートを取得します。
HTTPリクエスト
GET {{base_url}}/api/v5/routes
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| 制限 | 50 | 返すレコード |
| オフセット | 0 | 次に返されるレコード |
| ドライバーID | ドライバーID |
すべてのストアオーナールートを取得
curl --location -g --request GET '{{base_url}}/api/v5/routes/all_routes' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"limit": 10,
"offset": 10,
"start_date": dd-mm-yyyy,
"end_date": dd-mm-yyyy
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"routes": [
{
"id": 103110,
"start_address": "new york",
"end_address": "new york",
"start_latitude": 40.7128,
"start_longitude": 74.006,
"end_latitude": 40.7128,
"end_longitude": 74.006,
"created_at": "2021-07-21T04:07:41.000Z",
"route_name": "test",
"route_stops": [
{
"id": 222472903,
"address": "17475 Northwest 27th Avenue, Miami Gardens, FL, USA",
"latitude": 25.9330248,
"longitude": -80.2445472,
"notes": "GOod",
"optimize_status": "normal",
"stop_duration": 10,
"customer_name": "",
"customer_mobile_number": "",
"street": "17475 NW 27th Ave, Miami Gardens, FL 33056, EE. UU.",
"city": "Miami-Dade County",
"state": "Florida",
"country": "Estados Unidos",
"postal_code": "33056",
"customer_email": "",
"order_number": "",
"order_status": "route_created",
"h_no": "",
"locality": ""
}
]
}
],
"total_routes": 1
}
}
このエンドポイントはすべてのルートを取得します。
HTTPリクエスト
GET {{base_url}}/api/v5/routes/all_routes
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| 制限 | 50 | 返すレコード |
| オフセット | 0 | 次に返されるレコード |
| 開始日 | ゼロ | ルート開始日 (dd-mm-yyyy) |
| 終了日 | ゼロ | ルート終了日 (dd-mm-yyyy) |
店舗オーナーによるドライバーのルート作成を取得
curl --location --request POST '{{base_url}}/api/v5/routes/import_orders' \
--header 'Content-Type: multipart/form-data' \
--form 'start_address=""' \
--form 'end_address=""' \
--form 'driver_email="\"\""' \
--form 'api_key="\"\""' \
--form 'file=@"/path/to/file"'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 104244,
"start_address": "Delhi",
"end_address": "Delhi",
"start_latitude": 28.7040592,
"start_longitude": 77.1024902,
"end_latitude": 28.7040592,
"end_longitude": 77.1024902,
"created_at": "2021-09-27T06:18:29.000Z",
"route_name": "2021-Sep-09",
"route_stops": [
{
"id": 16921825,
"address": "Delhi",
"latitude": 28.7040592,
"longitude": 77.1024902,
"notes": "test",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "ayush",
"customer_mobile_number": "7838479870",
"street": "",
"city": "",
"state": "Delhi",
"country": "India",
"postal_code": "",
"customer_email": "ayush@gmail.com",
"order_number": null,
"order_status": "route_created",
"h_no": "",
"locality": ""
}
]
}
}
}
このエンドポイントは、ドライバーのルートを作成するために使用されます。
HTTPリクエスト
POST {{base_url}}/api/v5/routes/import_orders
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー（ページへ移動） ウェブサイトのURL ストアオーナーアカウントにログインし、ページに移動します 設定ページAPI トークンの取得と api_key の生成を選択します) |
| 開始アドレス | "" | ルートの開始アドレス |
| 終了アドレス | "" | ルートの終了アドレス |
| ドライバーのメールアドレス | "" | ドライバーのメール |
| file | "" | ファイルを xlsx 形式でアップロードします。リンクをクリックするとダウンロードできます(サンプルファイルのリンク) |
集配
ルートを作成する
curl -X POST \
{{base_url}}/api/v6/routes/ \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'postman-token: 5c922b4b-faf5-ea12-5660-518110acc248' \
-d '{
"api_key": "**************",
"driver_id": 11111111111111,
"start_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_latitude":19.1190749,
"start_longitude":72.8951151,
"end_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"end_latitude":19.1190749,
"end_longitude":72.8951151,
"route_name":"04-Jan-2022",
"stops":[
{
"id":1633502641818,
"address":"Taj Mahal pikcup",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"pickup",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":0,
"address_typed":{
"delivery_count":1
},
"stop_duration": 2,
"stop_order": 1,
"metadata": [{}]
},
{
"id":0,
"address":"Taj Mahal pickup link delivery",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"delivery",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":1633502641818,
"address_typed":{
"delivery_count":0
},
"stop_duration": 2,
"stop_order": 2
},
{
"id":0,
"address":"Taj Mahal seperate delivery",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"delivery",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":0,
"address_typed":{
"delivery_count":0
},
"stop_duration": 2,
"stop_order": 2
}
]
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 103169,
"route_name": "04-Jan-2022",
"start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_latitude": 19.1190749,
"start_longitude": 72.8951151,
"end_latitude": 19.1190749,
"end_longitude": 72.8951151,
"created_at": "2022-01-11T11:48:16.000Z",
"route_stops": [
{
"id": 222473230,
"address": "Taj Mahal seperate delivery",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 0
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 2,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 222473231,
"address": "Taj Mahal pickup",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 1
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 1,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 222473232,
"address": "Taj Mahal pickup linked delivery",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 0
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 2,
"h_no": "",
"locality": "",
"share_stop_id": 222473231
}
]
}
}
}
このエンドポイントはルートを作成します。
HTTPリクエスト
POST {{base_url}}/api/v6/routes
クエリパラメータ
| データ・タイプ | デフォルト | 説明 | |
|---|---|---|---|
| ドライバーID | 整数 (*) | ルートを作成するには driver_id が必要です | |
| 開始アドレス | 弦 （*） | ルートの開始位置からのアドレス | |
| 開始緯度 | 10進数 | 0 | start_address または start_latitude、start_longitude のいずれかが必要です |
| 開始経度 | 10進数 | 0 | start_address または start_latitude、start_longitude のいずれかが必要です |
| 終了アドレス | 文字列 | ルートの終了位置 | |
| 終了緯度 | 10進数 | end_address または end_latitude、end_longitude のいずれかが必要です | |
| 終了_経度 | 10進数 | end_address または end_latitude、end_longitude のいずれかが必要です | |
| ルート名 | 弦 （*） | 現在の日付(dd/mm/yy) | 路線名 |
| 停止する | オブジェクトの配列 (*) | オブジェクトの配列内の情報を停止します |
停止オブジェクトパラメータ
| データ・タイプ | デフォルト | 説明 | |
|---|---|---|---|
| id | INT(*) | 0 | 1. stop_type が配信の場合、ID を送信する必要はありません 2. stop_type ピックアップの場合は 20 桁の ID を送信する必要があります |
| ストップオーダー | 整数 (*) | 0 | 停車順を追加 |
| シェアストップID | int型 | 0 | 1. stop_type がピックアップの場合は、デフォルトのままにします。 2. stop_type が配送で、ピックアップとリンクしたくない場合は、デフォルトのままにしておきます 3. ピックアップにリンクしたい場合は、そのピックアップストップ ID の ID を入力します |
| 停止タイプ | 文字列 | 配達 | 値は配達と受け取りである必要があります |
| 住所 | 文字列 | 住所または緯度、経度のいずれかが必要です | |
| 緯度 | 10進数 | 0 | 住所または緯度、経度のいずれかが必要です |
| 経度 | 10進数 | 0 | 住所または緯度、経度のいずれかが必要です |
| ノート | 文字列 | 関連情報を停止します | |
| stop_duration | int型 | 2 | 停止の継続時間を分単位で指定します。つまり、顧客サイトでの停止にかかる時間を指定します。 |
| 顧客名 | 文字列 | お客様情報 | |
| customer_mobile_number | 文字列 | お客様情報 | |
| 顧客のメールアドレス | 文字列 | お客様情報 | |
| アドレス入力済み | {} | {} | 1. stop_type が Pickup の場合、キーはdelivery_count で、値は int で、配送の合計数がこのピックアップにリンクされます。 2. stop_type がdeliveryの場合はデフォルトのままにしておきます |
ルートを更新する
curl -X POST \
{{base_url}}/api/v6/routes/:route_id \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-H 'postman-token: 5c922b4b-faf5-ea12-5660-518110acc248' \
-d '{
"api_key": "**************",
"driver_id": 11111111111111,
"start_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_latitude":19.1190749,
"start_longitude":72.8951151,
"end_address":"Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"end_latitude":19.1190749,
"end_longitude":72.8951151,
"route_name":"04-Jan-2022",
"stops":[
{
"id":1633502641818,
"address":"Taj Mahal pikcup",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"pickup",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":0,
"address_typed":{
"delivery_count":1
},
"stop_duration": 2,
"stop_order": 1
},
{
"id":0,
"address":"Taj Mahal pickup link delivery",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"delivery",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":1633502641818,
"address_typed":{
"delivery_count":0
},
"stop_duration": 2,
"stop_order": 2
},
{
"id":0,
"address":"Taj Mahal seperate delivery",
"latitude":18.9225854,
"longitude":72.83315429999999,
"notes":"parsal in the left site",
"stop_type":"delivery",
"customer_name":"any",
"customer_mobile_number":"0123456789",
"customer_email":"example@gmail.com",
"share_stop_id":0,
"address_typed":{
"delivery_count":0
},
"stop_duration": 2,
"stop_order": 2
}
]
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 103169,
"route_name": "04-Jan-2022",
"start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_latitude": 19.1190749,
"start_longitude": 72.8951151,
"end_latitude": 19.1190749,
"end_longitude": 72.8951151,
"created_at": "2022-01-11T11:48:16.000Z",
"route_stops": [
{
"id": 222473230,
"address": "Taj Mahal seperate delivery",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 0
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 2,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 222473231,
"address": "Taj Mahal pickup",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 1
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 1,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 222473232,
"address": "Taj Mahal pickup linked delivery",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "parsal in the left site",
"optimize_status": "normal",
"stop_duration": 2,
"customer_name": "any",
"customer_mobile_number": "0123456789",
"street": "",
"city": "",
"state": "",
"country": "",
"postal_code": "",
"address_typed": {
"delivery_count": 0
},
"customer_email": "example@gmail.com",
"order_number": null,
"order_status": null,
"stop_order": 2,
"h_no": "",
"locality": "",
"share_stop_id": 222473231
}
]
}
}
}
このエンドポイント更新ルート。
HTTPリクエスト
POST {{base_url}}/api/v6/routes/:route_id
クエリパラメータ
クエリパラメータ
| データ・タイプ | デフォルト | 説明 | |
|---|---|---|---|
| ドライバーID | 整数 (*) | ルートを作成するには driver_id が必要です | |
| 開始アドレス | 弦 （*） | ルートの開始位置からのアドレス | |
| 開始緯度 | 10進数 | 0 | start_address または start_latitude、start_longitude のいずれかが必要です |
| 開始経度 | 10進数 | 0 | start_address または start_latitude、start_longitude のいずれかが必要です |
| 終了アドレス | 文字列 | ルートの終了位置 | |
| 終了緯度 | 10進数 | end_address または end_latitude、end_longitude のいずれかが必要です | |
| 終了_経度 | 10進数 | end_address または end_latitude、end_longitude のいずれかが必要です | |
| ルート名 | 弦 （*） | 現在の日付(dd/mm/yy) | 路線名 |
| 停止する | オブジェクトの配列 (*) | オブジェクトの配列内の情報を停止します |
停止オブジェクトパラメータ
| データ・タイプ | デフォルト | 説明 | |
|---|---|---|---|
| id | INT(*) | 0 | 1. stop_type が配信の場合、ID を送信する必要はありません 2. stop_type ピックアップの場合は 20 桁の ID を送信する必要があります |
| ストップオーダー | 整数 (*) | 0 | 停車順を追加 |
| シェアストップID | int型 | 0 | 1. stop_type がピックアップの場合は、デフォルトのままにします。 2. stop_type が配送で、ピックアップとリンクしたくない場合は、デフォルトのままにしておきます 3. ピックアップにリンクしたい場合は、そのピックアップストップ ID の ID を入力します |
| 停止タイプ | 文字列 | 配達 | 値は配達と受け取りである必要があります |
| 住所 | 文字列 | 住所または緯度、経度のいずれかが必要です | |
| 緯度 | 10進数 | 0 | 住所または緯度、経度のいずれかが必要です |
| 経度 | 10進数 | 0 | 住所または緯度、経度のいずれかが必要です |
| ノート | 文字列 | 関連情報を停止します | |
| stop_duration | int型 | 2 | 停止の継続時間を分単位で指定します。つまり、顧客サイトでの停止にかかる時間を指定します。 |
| 顧客名 | 文字列 | お客様情報 | |
| customer_mobile_number | 文字列 | お客様情報 | |
| 顧客のメールアドレス | 文字列 | お客様情報 | |
| アドレス入力済み | {} | {} | 1. stop_type が Pickup の場合、キーはdelivery_count で、値は int で、配送の合計数がこのピックアップにリンクされます。 2. stop_type がdeliveryの場合はデフォルトのままにしておきます |
ルート情報を取得する
curl --location -g --request GET '{{base_url}}/api/v6/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"route": {
"id": 104248,
"start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_latitude": 19.1190749,
"start_longitude": 72.8951151,
"end_latitude": 19.1190749,
"end_longitude": 72.8951151,
"created_at": "2021-12-30T07:32:10.000Z",
"route_name": "06-Oct-2021",
"route_stops": [
{
"id": 16921846,
"address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
"latitude": 18.9225854,
"longitude": 72.8331543,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra 400001, India",
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"postal_code": "400001",
"address_typed": {
"delivery_count": 2
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 16921847,
"address": "Juhu Beach, Mumbai, Maharashtra",
"latitude": 19.1095171,
"longitude": 72.8241298,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "Juhu Beach, Juhu, Mumbai, Maharashtra 400049, India",
"city": "Mumbai Suburban",
"state": "Maharashtra",
"country": "India",
"postal_code": "400049",
"address_typed": {
"delivery_count": 0
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 16921846
},
{
"id": 16921848,
"address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
"latitude": 19.1018504,
"longitude": 72.8262233,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "Juhu Rd, Juhu Tara, Juhu, Mumbai, Maharashtra 400049, India",
"city": "Mumbai Suburban",
"state": "Maharashtra",
"country": "India",
"postal_code": "400049",
"address_typed": {
"delivery_count": 0
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 16921846
},
{
"id": 16921849,
"address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
"latitude": 19.09326,
"longitude": 72.8281264,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "Juhu Rd, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra 400049, India",
"city": "Mumbai Suburban",
"state": "Maharashtra",
"country": "India",
"postal_code": "400049",
"address_typed": {
"delivery_count": 2
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 0
},
{
"id": 16921850,
"address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
"latitude": 18.9339261,
"longitude": 72.8313813,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra 400001, India",
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"postal_code": "400001",
"address_typed": {
"delivery_count": 0
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 16921849
},
{
"id": 16921851,
"address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
"latitude": 18.93197,
"longitude": 72.8350343,
"notes": "",
"optimize_status": "normal",
"stop_duration": 5,
"customer_name": "",
"customer_mobile_number": "",
"street": "Horniman Circle Garden, 11, Homji St, Kala Ghoda, Fort, Mumbai, Maharashtra 400001, India",
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"postal_code": "400001",
"address_typed": {
"delivery_count": 0
},
"customer_email": "",
"order_number": null,
"order_status": null,
"h_no": "",
"locality": "",
"share_stop_id": 16921849
}
]
}
}
}
このエンドポイントはルート情報を取得します。
HTTPリクエスト
GET {{base_url}}/api/v6/routes/:route_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ルートID | "" | ルートリストから取得したルートID |
| ドライバーID | "" | ルートのドライバー ID |
集荷配送ルートの削除
curl --location -g --request DELETE '{{base_url}}/api/v6/routes/:route_id' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
上記のコマンドは、次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Route deleted successfully"
}
このエンドポイントはルートを削除します。
HTTPリクエスト
DELETE {{base_url}}/api/v6/routes/:route_id
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ルートID | "" | ルートリストから取得したルートID |
| ドライバーID | "" | ルートのドライバー ID |
ルートの最適化情報を取得する
curl --location -g --request GET '{{base_url}}/api/v6/routes/:route_id/optimize_route' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key" : "api_key",
"driver_id": 44968
}'
optimize:true の場合、上記のコマンドは次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "success",
"data": {
"optimized": true,
"legs": [
{
"distance": {
"text": "11 km",
"value": 11545
},
"duration": {
"text": "22 mins 55 secs",
"value": 1375
},
"end_address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
"start_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_location": {
"lat": 19.1190749,
"lng": 72.8951151
},
"end_location": {
"lat": 19.09326,
"lng": 72.8281264
},
"stop_id": "16921855",
"optimize_status": "normal",
"stop_type": "pickup",
"arr_time": 1375,
"end_time": 1675,
"optimize_order": 1,
"stop_order": 4,
"share_stop_id": 0,
"address_typed": {
"delivery_count": 2
},
"overview_polyline": "ieusByg|{L|@Dj@N\\Nb@d@`@h@HRF`@MnAFvBL\\|APhA[NK^LXCj@WvBUh@EZXb@BbACh@K`AdAhAvAZjBDx@z@xAhD|ElA~Dz@nAn@LhBf@rCv@`BP|DX~BL`A?n@GrCy@l@Cx@@dBHv@NbAf@hFnCr@h@e@r@}@dA_DjCyBdBiB|Ak@n@_@j@k@xAQz@Gv@SvHEl@Mv@YhAg@bBsBvHu@|C_IlYw@hDkAhGgCtNs@nEo@jDn@t@f@bAb@hAPbAbAxK^dDAbABj@AjAM`AcAdD]tAMz@]tCOzAmBlIcCjJ?j@JT\\ZvUxCMfAQx@C^m@vBm@vAqAvB{EzGzDvB~BhAbUbHXPj@jGcAxMCpBb@xN@~AKlApCj@jBZpBNjNClAI@R}E`OyC~QoDtWaC|O?LFXJLPFZBlI]lHy@nCg@tFk@pBOT?^FXRHR\\hBBHFFD@X?~B[dCYHCHGFO@SEaA@WFQHKXMT@vEYxG[x@ADf@"
},
{
"distance": {
"text": "21 km",
"value": 21458
},
"duration": {
"text": "34 mins 46 secs",
"value": 2086
},
"end_address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
"start_address": "Hotel Sea Princess, Juhu Road, near Juhu Beach, Airport Area, Juhu, Mumbai, Maharashtra, India",
"start_location": {
"lat": 19.09326,
"lng": 72.8281264
},
"end_location": {
"lat": 18.9225854,
"lng": 72.8331543
},
"stop_id": "16921852",
"optimize_status": "normal",
"stop_type": "pickup",
"arr_time": 3461,
"end_time": 3761,
"optimize_order": 2,
"stop_order": 1,
"share_stop_id": 0,
"address_typed": {
"delivery_count": 2
},
"overview_polyline": "gdpsBufo{LEg@~C?`@DZLZTh@j@h@Xb@JtNx@`BXz@FrBEn@?t@SnDZHEHONg@^kDhAyHfBuIf@mCx@}LdLLbCFvIB~r@pAtBF~CTtIfAbA@zAC~AW|JwCxBk@~EyAzD{AfBi@pAa@tJsC|Ai@rK`@p@?fAE~@Sv@_@vCcB^QXK~E]xBg@xGq@lAGrRC`JGzAUlTkIrPuGzEuA|AYbHo@bIMpFNbERpI\\fUtCxGx@zDb@`APh@`@hEgBv@_@rBqDd@e@f@SbAQ`B?TCpA[j@YXMZWf@w@bOaXNo@KUCWBWHULQRKZGZBXNNTHX?XFTLLnA~@`MpIjHlE~@v@rHlE~LvGbBj@zEjApBv@nBdA`CzAdA~@n@r@p@f@l@Zn@Pv@Nr@ZrCj@fGz@|Cv@`B\\|Dh@l@PpANlE?nABbAZ|DbBfB`@fALrOh@~@Hn@RlCvAl@Vn@Jb@?zDWzCI`C?rBJrTrAnBTbBXbFdAvEdA|LhBbGl@tATfAJr@A|AI|AMxB[|BOf@H|Bf@n@NrAx@lAdAv@\\t@JvEBfFI`HQR?d@Fp@ExCFvAHvGjAr@J`@JhETdFHhBHvC@h@DvB\\f@BlD@jAExBa@t@IlAG^G\\ObAkA\\Q`@GxE_@tDS~AUXO\\[`AgAb@]f@[p@U`JaB~@K`AAjAGdAOl@Md@OjBq@~@a@t@Sn@Ef@?tCTbC`@nFtAbAb@`@L\\DZ?|WwArBEfBAxBh@vBt@nEfA|Cp@dBl@p@\\~LfIVTTb@TXh@HTNbCMpHKjICxH@tACz@Qt@]bAeAXg@?Q@QFOJMLGPEN?N@rB{@|C_CfA{@J?@BJFt@dANNN@J?tAgALGVA~E|ATRYAoE}AUEKDiAx@"
},
{
"distance": {
"text": "1 km",
"value": 1314
},
"duration": {
"text": "6 mins 4 secs",
"value": 364
},
"end_address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
"start_address": "Taj Mahal Tower, Mumbai, PJ Ramchandani Marg, Apollo Bandar, Colaba, Mumbai, Maharashtra, India",
"start_location": {
"lat": 18.9225854,
"lng": 72.8331543
},
"end_location": {
"lat": 18.93197,
"lng": 72.8350343
},
"stop_id": "16921857",
"optimize_status": "normal",
"stop_type": "delivery",
"arr_time": 3825,
"end_time": 4125,
"optimize_order": 3,
"stop_order": 6,
"share_stop_id": 16921855,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "aznrBmgp{Lc@XICoAgBKG_GtEi@l@S^@TCPOXMJQFS?[IOMIMCQ?Q@QFOGUEa@[gASq@q@o@[QiASyAKmDc@uEsAmAc@s@a@y@i@_BuAi@OoF_@"
},
{
"distance": {
"text": "1 km",
"value": 1082
},
"duration": {
"text": "6 mins 33 secs",
"value": 393
},
"end_address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
"start_address": "Horniman Circle Garden, Homji Street, Kala Ghoda, Fort, Mumbai, Maharashtra, India",
"start_location": {
"lat": 18.93197,
"lng": 72.8350343
},
"end_location": {
"lat": 18.9339261,
"lng": 72.8313813
},
"stop_id": "16921856",
"optimize_status": "normal",
"stop_type": "delivery",
"arr_time": 4218,
"end_time": 4518,
"optimize_order": 4,
"stop_order": 5,
"share_stop_id": 16921855,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "isprB{up{LcAIVKzAJn@v@Pn@Ar@I^QZWV[N_@Ha@A[E[OGJSFkHu@sBjKqBxIxBS|B["
},
{
"distance": {
"text": "20 km",
"value": 20984
},
"duration": {
"text": "35 mins 42 secs",
"value": 2142
},
"end_address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
"start_address": "Standard Chartered Mumbai 23-25 M G Road, Mumbai Branch, 23-25, Mahatma Gandhi Road, Azad Maidan, Fort, Mumbai, Maharashtra, India",
"start_location": {
"lat": 18.9339261,
"lng": 72.8313813
},
"end_location": {
"lat": 19.1018504,
"lng": 72.8262233
},
"stop_id": "16921854",
"optimize_status": "normal",
"stop_type": "delivery",
"arr_time": 6360,
"end_time": 6660,
"optimize_order": 5,
"stop_order": 3,
"share_stop_id": 16921852,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "y_qrB_zo{LrDc@Yk@Y[w@c@cK}GoAm@qA_@cJuB_Cy@kBa@eB?uBD_ThAoBHe@?SAu@WaA]qFwA_AQ_AOuCSc@Am@Du@R}@^mBr@e@Nm@LgANmAF_AB_AH_J~Am@Tg@Xc@\\_AfA_@\\]N_BVwDRyE^]FYNeAhAa@Ra@FmAFs@H{B`@mADoDAg@CwB]g@EwCAkBIeFIiEUoAM_HoAsBK{EGaDLoJNcACuCC{@M{@a@mAcAsAw@i@Q_Cg@a@E}BLsBXaBNaAFsABiAKsAUgE_@{@Q}LkBuEiAaFeAeBWmBUqTsAsBK_C?{CH{DVg@Aq@Ko@WmCwAm@S}@GqOi@kAMiBa@}DeB_AYmAEqE?qAOs@@}Dk@wBa@sA]oB_@iAQaC]uCk@w@GgASe@Qu@]u@k@i@m@gAcAiC_BcB}@uBy@_B]_D}@_A[}Aw@aH{Du@q@aC{AqDsBgAg@mHkE_MkImBmAQCSDSASE]\\_FpIiHlM[n@O`@Kb@EhBGVKJKBMAu@k@c@Wa@Wu@K_A?_ANc@Rc@`@sBrDyG`DcB_AyMcBmBSsCc@_M_BeW}@aILaHn@{AXwEtAiK|DgDvAmTnIaBV{]Fy@DeHv@_CLOHaCXmARi@RqDtBe@NaATiBFiLc@OB_C|@mDjAyJvCoC`A}C|@wD~@_IjC_B^gAHcBB}@CmJkAqF]sNMmFKg\\w@wIFaCMcDAqFMm@vIU|BaC|Ly@bFi@|DKvAIZOJUAoD[u@Ro@?sBD{@GaBYuNy@c@Ki@Yi@k@[U[Ma@EyE@yGZwEX[TORCXDnAEREFSNyGdAS@OCMIIM_@sBEIQOYKuDVqIdAw@L}@HB\\XHHF@LAHEHw@J"
},
{
"distance": {
"text": "1 km",
"value": 1040
},
"duration": {
"text": "7 mins 48 secs",
"value": 468
},
"end_address": "Juhu Beach, Mumbai, Maharashtra",
"start_address": "JW Marriott Mumbai Juhu, Juhu Road, Juhu Tara, Juhu, Mumbai, Maharashtra, India",
"start_location": {
"lat": 19.1018504,
"lng": 72.8262233
},
"end_location": {
"lat": 19.1095171,
"lng": 72.8241298
},
"stop_id": "16921853",
"optimize_status": "normal",
"stop_type": "delivery",
"arr_time": 6828,
"end_time": 7128,
"optimize_order": 6,
"stop_order": 2,
"share_stop_id": 16921852,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "_zqsB_}n{Le@HM?MGEGCOBKRME]cBVkBL}H^QEyDb@wHXMRE\\Bj@GLOPYHqA?]DUXAfBmC~@WRJdA"
},
{
"distance": {
"text": "9 km",
"value": 9969
},
"duration": {
"text": "26 mins 34 secs",
"value": 1594
},
"end_address": "Raheja Vihar, Chandivali, Powai, Mumbai, Maharashtra, India",
"start_address": "Juhu Beach, Mumbai, Maharashtra",
"start_location": {
"lat": 19.1095171,
"lng": 72.8241298
},
"end_location": {
"lat": 19.1190749,
"lng": 72.8951151
},
"stop_id": null,
"optimize_status": "normal",
"stop_type": "normal",
"arr_time": 8422,
"end_time": 0,
"optimize_order": 7,
"stop_order": 2000,
"share_stop_id": 0,
"address_typed": {
"delivery_count": 0
},
"overview_polyline": "ogssBenn{LKeAVSlC_A@gBKBAaAGaA@u@CQX@JUCY{@Bg@E[GeEwByFgDs@m@kAsAu@UdBqDsC@_ICyKBU?DeSJgCEoGLuC@y@E{EGe@MmDIYGc@KuD@mDG]GsEAwGBeD@Y|@cE`@wBL{@\\sFr@{EB_@?]GwABkCP_Cf@iBvCuGpBeDv@kDn@{DrEyQp@gDVeBV{BZiBnAuEPw@Fo@@}@GoAkA{M[{CY_A[w@g@u@UUWc@pH_c@z@kDhEuOxBsIj@oBxDoNJy@Dy@JcFHgB\\gBXs@l@mAb@g@r@s@zCgChEgDhAyASKSUiFwC_@Mu@Qy@GkAEi@@i@F}@XmAVm@Hq@@qAE{Gc@cAOwC{@mBe@_@IEU{@oAmA_EiD}E{@yAEy@[kBiAwAaAeAi@JcABc@C[Yi@DwBTk@VYB_@MOJiAZ}AQM]GwBLoAGa@ISa@i@c@e@]Ok@O}@E"
}
]
}
}
optimize:false の場合、上記のコマンドは次のような構造の JSON を返します。
{
"code": 200,
"status": true,
"message": "Some stops is not settled in route optimization",
"data": {
"optimized": false,
"legs": [],
"route_stops": [
{
"id": 17019017,
"address": "New York",
"latitude": 40.7128,
"longitude": 74.006,
"optimized": false,
"errors": [
"Could not found nearest road"
]
}
]
}
}
このエンドポイントはルート情報を取得します。
HTTPリクエスト
GET {{base_url}}/api/v6/routes/:route_id/optimize_route
クエリパラメータ
| デフォルト | 説明 | |
|---|---|---|
| api_key | "" | APIアクセスキー |
| ドライバーID | "" | ルートのドライバー ID |
Webフック
ZeoRoutePlanner では、イベントについて通知できる Webhook を使用できます。 新しい Webhook をプラットフォーム (「https://zeorouteplanner.com/app/team/settings/genrate-token」).
イベント
- 進行状況の停止 Webhook
エラー
Zeo Route Planner API は次のエラー コードを使用します。
| エラーコード | 意味 |
|---|---|
| 400 | 不正なリクエスト -- リクエストは無効です。 |
| 401 | 権限がありません -- API キーが間違っています。 |
| 404 | 見つかりません -- 指定されたリクエストが見つかりませんでした。 |
| 500 | 内部サーバー エラー -- サーバーに問題が発生しました。 あとでもう一度試してみてください。 |
| 503 | サービスを利用できません -- メンテナンスのため一時的にオフラインになっています。 後でもう一度試してください。 |