{ "info": { "_postman_id": "828669e0-480a-411b-b2be-9ce495dc2629", "name": "WW Route Manager API - RM-18395", "description": "WorkWave Route Manager API\nhttps://wwrm.workwave.com/api/", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "39638492", "_collection_link": "https://go.postman.co/collection/39638492-828669e0-480a-411b-b2be-9ce495dc2629?source=collection_link" }, "item": [ { "name": "Callback API", "item": [ { "name": "Get Callback URL", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/callback", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "callback" ] } }, "response": [] }, { "name": "Set Callback URL", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhook.site/395d6ab8-f2c5-4dc5-95cd-f56c8e640335\",\n \"signaturePassword\": \"g394g732vhsdfiv34\",\n \"test\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/callback", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "callback" ] } }, "response": [] }, { "name": "Delete Callback URL", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/callback", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "callback" ] } }, "response": [] } ] }, { "name": "Validation API", "item": [ { "name": "Validate Contact Info", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"emailAddresses\": [\"test@example.com\", \"test@example.\"],\n \"phoneNumbers\": [\"+18007620301\", \"+83244\"],\n \"allowBlank\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/validation/contacts", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "validation", "contacts" ] } }, "response": [] } ] }, { "name": "Companies API", "item": [ { "name": "Add Company", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ACME1 Corp\",\n \"enabled\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/companies", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "companies" ] } }, "response": [] }, { "name": "List Companies", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/companies", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "companies" ] } }, "response": [] }, { "name": "Replace Company", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ACME111 Corp\",\n \"enabled\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/companies/{{wwrm-companyId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "companies", "{{wwrm-companyId}}" ] } }, "response": [] }, { "name": "Delete Company", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/companies/{{wwrm-companyId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "companies", "{{wwrm-companyId}}" ] } }, "response": [] } ] }, { "name": "Territories API", "item": [ { "name": "List Territories", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories" ] } }, "response": [] }, { "name": "Edit Territory", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"statusReasons\": [\"Absent recipient\",\"Absent recipient2\"]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}" ] } }, "response": [] }, { "name": "Edit PlanningRange", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"exportDeletedOrders\": true,\n \"planningRange\": 7,\n \"email\": \"test.user@workwave.com\",\n \"cfg\": {\n \"format\": \"XLSX\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/planningrange", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "planningrange" ] } }, "response": [] } ] }, { "name": "Simulations API", "item": [ { "name": "List Simulations", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulations", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulations" ] } }, "response": [] } ] }, { "name": "Depots API", "item": [ { "name": "List Depots", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/depots", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "depots" ] } }, "response": [] }, { "name": "Add Depots", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"depots\": [\n {\n \"name\": \"depot101\",\n \"location\": {\n \"address\": \"Santa Maria segreta, 1, 20123 Milano MI, Italy\",\n \"geoAddress\": \"Via Dante, 1, 20121 Milano MI, Italy\",\n \"status\": \"OK\",\n \"source\": \"G_GEO\",\n \"latLng\": [\n 45465412,\n 9185965\n ],\n \"rooftopLatLng\": [\n 45465359,\n 9185901\n ]\n },\n \"setupCost\": 1000,\n \"setupTimeSec\": -1,\n \"color\": \"446600\"\n },\n {\n \"name\": \"depot102\",\n \"location\": {\n \"address\": \"Via Manfredo Camperio, 16, 20123 Milano MI, Italy\",\n \"geoAddress\": \"Via Manfredo Camperio, 16, 20123 Milano MI, Italy\",\n \"status\": \"OK\",\n \"source\": \"G_GEO\",\n \"latLng\": [\n 45467475,\n 9182658\n ],\n \"rooftopLatLng\": [\n 45467572,\n 9182999\n ]\n },\n \"setupCost\": 2000,\n \"setupTimeSec\": -1,\n \"color\": \"CC002D\"\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/depots", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "depots" ] } }, "response": [] }, { "name": "Update Depots", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"depots\": [\n {\n \"id\": \"0e6c5165-d4bc-4003-abbc-467fe11981c5\",\n \"name\": \"New Depot Name\",\n \"color\": \"FF0000\"\n },\n {\n \"id\": \"431f6677-1415-45cc-9e0d-2dadca31ac79\",\n \"name\": \"Depot example\",\n \"color\": \"99CC10\"\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/depots", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "depots" ] } }, "response": [] }, { "name": "Delete Depots", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"depotIds\": [\n \"0e6c5165-d4bc-4003-abbc-467fe11981c5\"\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/depots", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "depots" ] } }, "response": [] } ] }, { "name": "Regions API", "item": [ { "name": "List Regions", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/regions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "regions" ] } }, "response": [] }, { "name": "Add Regions", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"regions\": [\n {\n \"name\": \"Route 1\",\n \"color\": \"2E5984\",\n \"poly\": [\n [\n 45477684,\n 9164052\n ],\n [\n 45473772,\n 9165211\n ],\n [\n 45471274,\n 9166670\n ],\n [\n 45472839,\n 9172206\n ],\n [\n 45477263,\n 9175467\n ],\n [\n 45479941,\n 9168558\n ]\n ],\n \"enterCost\": 2000,\n \"enterTimeSec\": 1200\n },\n {\n \"name\": \"Route 2\",\n \"color\": \"0D8800\",\n \"enterCost\": 2500,\n \"enterTimeSec\": 1800,\n \"poly\": [\n [\n 45477684,\n 9164052\n ],\n [\n 45473772,\n 9165211\n ],\n [\n 45471274,\n 9166670\n ],\n [\n 45472839,\n 9172206\n ],\n [\n 45477263,\n 9175467\n ],\n [\n 45479941,\n 9168558\n ]\n ]\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/regions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "regions" ] } }, "response": [] }, { "name": "Replace Regions", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"regions\": [\n {\n \"id\": \"f616d7d3-aaaf-4f4a-baeb-11a77acdd533\",\n \"name\": \"Route 11\",\n \"color\": \"2E5984\",\n \"poly\": [\n [\n 45477684,\n 9164052\n ],\n [\n 45473772,\n 9165211\n ],\n [\n 45471274,\n 9166670\n ],\n [\n 45472839,\n 9172206\n ],\n [\n 45477263,\n 9175467\n ],\n [\n 45479941,\n 9168558\n ]\n ],\n \"enterCost\": 1000,\n \"enterTimeSec\": 2000\n },\n {\n \"id\": \"18e129a5-46e9-467b-82f9-f899d31b0ed0\",\n \"name\": \"Route 22\",\n \"color\": \"0D8800\",\n \"enterCost\": 100,\n \"enterTimeSec\": 200,\n \"poly\": [\n [\n 45477684,\n 9164052\n ],\n [\n 45473772,\n 9165211\n ],\n [\n 45471274,\n 9166670\n ],\n [\n 45472839,\n 9172206\n ],\n [\n 45477263,\n 9175467\n ],\n [\n 45479941,\n 9168558\n ]\n ]\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/regions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "regions" ] } }, "response": [] }, { "name": "Delete Regions", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"regionIds\": [\n \"f616d7d3-aaaf-4f4a-baeb-11a77acdd533\",\n \"18e129a5-46e9-467b-82f9-f899d31b0ed0\"\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/regions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "regions" ] } }, "response": [] } ] }, { "name": "Drivers API", "item": [ { "name": "List Drivers", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/drivers", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "drivers" ] } }, "response": [] }, { "name": "Add Driver", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Driver 33\",\n \"email\": \"driver33@example.com\",\n \"password\": \"PhQ?Hqrt$4bs6_^2\",\n \"summarizeFutureMobileRoute\": false,\n \"mobileFutureDaysVisibility\": -1,\n \"gpsDeviceId\": null,\n \"barcodeAttachmentAllowed\":true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/drivers", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "drivers" ] } }, "response": [] }, { "name": "Replace a Driver", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Driver 3 - Replaced\",\n \"email\": \"driver3replaced@example.com\",\n \"password\": \"newpassword\",\n \"summarizeFutureMobileRoute\": false,\n \"mobileFutureDaysVisibility\": 2,\n \"barcodeAttachmentAllowed\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/drivers/{{wwrm-driverId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "drivers", "{{wwrm-driverId}}" ] } }, "response": [] }, { "name": "Update multiple Drivers", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"driverIds\": [\"617e4d24-01e0-4d7a-a421-d96d5353b333\", \"8b6fb165-0820-48ed-897f-06fb6172db46\"],\n \"summarizeFutureMobileRoute\": false,\n \"mobileFutureDaysVisibility\": 2,\n \"barcodeAttachmentAllowed\": true\n\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/drivers", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "drivers" ] } }, "response": [] }, { "name": "Delete a Driver", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/drivers/{{wwrm-driverId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "drivers", "{{wwrm-driverId}}" ] } }, "response": [] } ] }, { "name": "Vehicles API", "item": [ { "name": "Simulations", "item": [ { "name": "List Vehicles", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/vehicles", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "vehicles" ] } }, "response": [] } ] }, { "name": "Operations", "item": [ { "name": "Replace Vehicle Settings", "item": [ { "name": "Normal Day", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"available\": true,\n \"notes\": \"normal day updated via API\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 25200,\n \"endSec\": 72000\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 5000,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"pebbles\": 70000\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 9500,\n \"drivingTimeCost\": 0,\n \"idleTimeCost\": 100,\n \"serviceTimeCost\": 100,\n \"breakTimeCost\": 100,\n \"kmCost\": 25,\n \"tags\": [],\n \"speedFactor\": 100,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0,\n \"maxOrders\": 0\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-vehicleId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-vehicleId}}" ] } }, "response": [] }, { "name": "Specific Day", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"available\": true,\n \"notes\": \"updated via API\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 25200,\n \"endSec\": 72000\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 5000,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"pebbles\": 70000\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 9500,\n \"drivingTimeCost\": 0,\n \"idleTimeCost\": 100,\n \"serviceTimeCost\": 100,\n \"breakTimeCost\": 100,\n \"kmCost\": 25,\n \"tags\": [],\n \"speedFactor\": 100,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0,\n \"maxOrders\": 0\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-vehicleId}}/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-vehicleId}}", "{{wwrm-date}}" ] } }, "response": [] } ] }, { "name": "Bulk Replace Vehicle Settings", "item": [ { "name": "Specific Day", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"settings\": {\n \"cb1c9af3-dc1c-4749-8530-0c89f1b0aac6\": {\n \"available\": true,\n \"notes\": \"bulk updated via API\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 25200,\n \"endSec\": 72000\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 5000,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"pebbles\": 70000\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 9500,\n \"drivingTimeCost\": 0,\n \"idleTimeCost\": 100,\n \"serviceTimeCost\": 100,\n \"breakTimeCost\": 100,\n \"kmCost\": 25,\n \"tags\": [],\n \"speedFactor\": 100,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0,\n \"maxOrders\": 0\n },\n\n \n \"a4365245-7104-40af-a6ae-d29498f03350\": {\n \"available\": true,\n \"notes\": \"bulk updated via API\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 25200,\n \"endSec\": 72000\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 5000,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"pebbles\": 70000\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 9500,\n \"drivingTimeCost\": 0,\n \"idleTimeCost\": 100,\n \"serviceTimeCost\": 100,\n \"breakTimeCost\": 100,\n \"kmCost\": 25,\n \"tags\": [],\n \"speedFactor\": 100,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0,\n \"maxOrders\": 0\n }\n }\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-date}}" ] } }, "response": [] }, { "name": "Normal Day", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"settings\": {\n \"cb1c9af3-dc1c-4749-8530-0c89f1b0aac6\": {\n \"available\": true,\n \"notes\": \"settings for 2015-12-03 updated via REST API, bulk version, normal day\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 28800,\n \"endSec\": 61200\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"perStopTimeSec\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 0,\n \"maxOrders\": 0,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"people\": 600\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 0,\n \"drivingTimeCost\": 2000,\n \"idleTimeCost\": 2000,\n \"serviceTimeCost\": 2000,\n \"breakTimeCost\": 2000,\n \"kmCost\": 100,\n \"tags\": [\n \"heavy\",\n \"medium\"\n ],\n \"speedFactor\": 120,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0\n },\n \"a4365245-7104-40af-a6ae-d29498f03350\": {\n \"available\": true,\n \"notes\": \"settings for 2015-12-03 updated via REST API, bulk version, normal day\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": null,\n \"timeWindow\": {\n \"startSec\": 28800,\n \"endSec\": 61200\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"perStopTimeSec\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 0,\n \"maxOrders\": 0,\n \"breaks\": [\n {\n \"startSec\": 43200,\n \"endSec\": 48600,\n \"durationSec\": 1800\n }\n ],\n \"loadCapacities\": {\n \"frozen ton\": 500,\n \"regular ton\": 500\n },\n \"regionIds\": [\n \"8b45da96-f4e2-4adb-a5d8-7f238cc3a0c9\",\n \"f2880d2e-5243-4b40-9ea1-e6b7b47fef61\"\n ],\n \"activationCost\": 0,\n \"drivingTimeCost\": 2500,\n \"idleTimeCost\": 2500,\n \"serviceTimeCost\": 3500,\n \"breakTimeCost\": 1500,\n \"kmCost\": 115,\n \"tags\": [\n \"frozen\",\n \"regular\"\n ],\n \"speedFactor\": 150,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0\n }\n }\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles" ] } }, "response": [] } ] }, { "name": "List Vehicles", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles" ] } }, "response": [] }, { "name": "Add Vehicles", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"vehicles\": [\n {\n \"externalId\": \"New Vehicle #1\",\n \"color\": \"c08e88\",\n \"tracked\": true,\n \"sameSideOfStreet\": true,\n \"gpsDeviceId\": null,\n \"settings\": {\n \"available\": true,\n \"notes\": \"Vehicle added via REST API\",\n \"departureDepotId\": \"f3cb3784-2d54-4ca8-a046-7fd0c45a7972\",\n \"arrivalDepotId\": \"d1de2ce9-72b0-48b4-b70d-a3e4654f7fe4\",\n \"timeWindow\": {\n \"startSec\": 28800,\n \"endSec\": 61200\n },\n \"flexStartTime\": true,\n \"perStopCost\": 0,\n \"perStopTimeSec\": 0,\n \"maxWorkingTimeSec\": 0,\n \"maxDrivingTimeSec\": 0,\n \"maxDistanceMt\": 0,\n \"maxOrders\": 0,\n \"breaks\": [],\n \"loadCapacities\": {\n \"people\": 1500\n },\n \"regionIds\": [],\n \"activationCost\": 10000,\n \"drivingTimeCost\": 2000,\n \"idleTimeCost\": 2000,\n \"serviceTimeCost\": 2000,\n \"breakTimeCost\": 2000,\n \"kmCost\": 100,\n \"tags\": [\n \"light\"\n ],\n \"speedFactor\": 130,\n \"minWorkingTimeSec\": 0,\n \"minLoadCapacities\": {},\n \"preparationTimeSec\": 600,\n \"closeOutTimeSec\": 0\n }\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles" ] } }, "response": [] }, { "name": "Delete a Vehicle", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-vehicleId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-vehicleId}}" ] } }, "response": [] }, { "name": "Delete Vehicles", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"9836139d-ccbc-4e5e-a886-0525a2d35a70\",\n \"a94fb608-7153-411b-8cdb-bd99eee4cf78\"\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles" ] } }, "response": [] }, { "name": "Get Vehicle Settings -Normal day", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-vehicleId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-vehicleId}}" ] } }, "response": [] }, { "name": "Get Vehicle Settings -Specific date", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-vehicleId}}/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-vehicleId}}", "{{wwrm-date}}" ] } }, "response": [] }, { "name": "List Vehicle Settings", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "{{wwrm-date}}" ] } }, "response": [] }, { "name": "Update Vehicles Details", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"details\": [\n {\n \"id\": \"cb1c9af3-dc1c-4749-8530-0c89f1b0aac6\",\n \"externalId\": \"Test Vehicle\"\n },\n {\n \"id\": \"a4365245-7104-40af-a6ae-d29498f03350\",\n \"color\": \"ff0000\"\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicles/details", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicles", "details" ] } }, "response": [] } ] } ] }, { "name": "Vehicle-Driver Assignments API", "item": [ { "name": "Get Driver Assignments", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicledriverassignments/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicledriverassignments", "{{wwrm-date}}" ] } }, "response": [] }, { "name": "Replace Driver Assignments", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"assignments\": {\n \"a4365245-7104-40af-a6ae-d29498f03350\": \"f252bfb6-953b-4f8f-a02c-263a10e10bb1\",\n \"492c1f4b-467d-4349-ae0a-0947f0baa4da\": \"a3ea0257-fa3b-40b7-967b-952bda56c8c0\",\n \"e3980635-9d45-4438-a496-4805b92f0c32\": \"df5ac8b5-d7cd-41ee-a91c-9d794f58f7e6\"\n }\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/vehicledriverassignments/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "vehicledriverassignments", "{{wwrm-date}}" ] } }, "response": [] } ] }, { "name": "Orders API", "item": [ { "name": "Operations", "item": [ { "name": "List Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders?include=all", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ], "query": [ { "key": "include", "value": "all" } ] } }, "response": [] }, { "name": "Get Orders (querystring)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders?ids=3b7df97f-481d-4511-b936-c81e465d18bf,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ], "query": [ { "key": "ids", "value": "3b7df97f-481d-4511-b936-c81e465d18bf,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6" } ] } }, "response": [] }, { "name": "Add Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"strict\": false,\n \"acceptBadGeocodes\": true,\n \"orders\": [\n {\n \"name\": \"Delivery-type Order at address to be geocoded\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Pickup-type Order at address to be geocoded\",\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Service-type Order at address to be geocoded (service-type orders are just delivery-type Orders flagged as 'isService'\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n },\n \"isService\": true\n },\n {\n \"name\": \"Pickup&Delivery-type Order at addresses to be geocoded\",\n \"loads\": {\n \"pounds\": 100\n },\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Pickup&Delivery-type Order with pickup at a depot and delivery at an address to be geocoded\",\n \"loads\": {\n \"pounds\": 100\n },\n \"pickup\": {\n \t\"depotId\": \"enter-a-valid-depot-id-here--use-list-depots-to-get-depot-ids\",\n \"serviceTimeSec\": 180\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 1200\n }\n },\n {\n \"name\": \"Delivery w/ latitude&longitude (faster, no geocode necessary)\",\n \"delivery\": {\n \"location\": {\n \"address\": \"What's written here should still be a valid address, even if that's not strictly required as no geocoding takes place when latLng is specified\",\n\t\t \"latLng\": [\n\t\t \t45479039,\n\t\t 9222647\n\t\t ]\n }\n }\n },\n {\n \"name\": \"Delivery at generic address resulting in LOW ACCURACY geocode warning\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Milano\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Delivery w/ TimeWindows Exceptions\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 57600,\n \"endSec\": 61200\n }\n ],\n \"timeWindowExceptions\": {\n \"20160627\": [\n {\n \"startSec\": 64800,\n \"endSec\": 68400\n }\n ],\n \"20160628\": [\n {\n \"startSec\": 30600,\n \"endSec\": 37800\n },\n {\n \"startSec\": 61200,\n \"endSec\": 64800\n }\n ]\n }\n }\n },\n {\n \"name\": \"Delivery at invalid address (NOT_FOUND)\",\n \"delivery\": {\n \"location\": {\n \"address\": \"vbieufbvikuafgadfga\"\n }\n }\n },\n { \n \"name\": \"Delivery requiring a specific vehicle\",\n \"forceVehicleId\": \"enter-a-valid-vehicle-id-here--use-list-vehicles-to-get-vehicle-ids\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery by a specific date\",\n \"eligibility\": {\n \"type\": \"by\",\n \"byDate\": \"20171031\"\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery on specific dates\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\"20171031\", \"20171101\", \"20171102\"]\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery specifying all supported Order and OrderStep fields\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\"20171031\", \"20171101\", \"20171102\"]\n },\n \"forceVehicleId\": null,\n \"priority\": 20,\n \"loads\": {\n \"pounds\": 100,\n \"oranges\": 50,\n \"apples\": 200,\n \"people\": 12\n },\n \"pickup\": null,\n \"delivery\": {\n \t\"depotId\": null,\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 32400,\n \"endSec\": 36000\n },\n {\n \"startSec\": 54000,\n \"endSec\": 64800\n }\n ],\n \"timeWindowExceptions\": {},\n \"notes\": \"some notes here\",\n \"serviceTimeSec\": 600,\n \"tagsIn\": [\"large_truck\", \"two_men_teams\"],\n \"tagsOut\": [\"yellow_truck\"],\n \"customFields\": {\n \"custom1\": \"custom1val\",\n \"custom2\": \"custom2val\"\n }\n },\n \"isService\": false\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ] } }, "response": [] }, { "name": "Replace Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Order 6 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20250104\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ],\n \"notes\": \"Order replaced via API\",\n \"serviceTimeSec\": 900,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n },\n \"acceptBadGeocodes\" : true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Update Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "\n{\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ]\n },\n \"acceptBadGeocodes\" : true\n}\n\n" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Update Orders", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"strict\": false,\n \"orders\": [\n {\n \"id\": \"24b37009-6b32-4956-83ed-9fab6fb51246\",\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ]\n }\n },\n {\n \"id\": \"61f3ba35-6bc1-46b2-90bf-096a29fa2fa0\",\n \"delivery\": {\n \"serviceTimeSec\": 600\n }\n }\n ],\n \"acceptBadGeocodes\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ] } }, "response": [] }, { "name": "Replace OrderStep", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"location\": {\r\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\r\n },\r\n \"timeWindows\": [\r\n {\r\n \"startSec\": 22000,\r\n \"endSec\": 64000\r\n }\r\n ],\r\n \"notes\": \"Delivery OrderStep replaced via API\",\r\n \"serviceTimeSec\": 0,\r\n \"tagsIn\": null,\r\n \"tagsOut\": null,\r\n \"customFields\": {\r\n \"custom3\": \"custom3val\"\r\n }\r\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders/{{wwrm-orderId}}/delivery", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders", "{{wwrm-orderId}}", "delivery" ] } }, "response": [] }, { "name": "Delete Order", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Delete Orders", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"ids\": [\n\t\t\"61f3ba35-6bc1-46b2-90bf-096a29fa2fa0\",\n\t\t\"daf08435-57fa-4ae0-a579-9d5aa022a93c\",\n\t\t\"bfdb8e20-e1d3-4951-b9b7-281babd338e6\"\n\t]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ] } }, "response": [] }, { "name": "Delete Orders (querystring)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders?ids=a275647b-33e4-46a2-a0a9-46c648e526c3,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ], "query": [ { "key": "ids", "value": "a275647b-33e4-46a2-a0a9-46c648e526c3,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6" } ] }, "description": "Limited to 20 (safe) or 200 (max) UUIDs because of querystring size limits" }, "response": [] }, { "name": "Delete OrderStep", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders/{{wwrm-orderId}}/pickup", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders", "{{wwrm-orderId}}", "pickup" ] } }, "response": [] }, { "name": "Replace (multiple) Orders", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orders\": [\n {\n \"id\": \"4d841589-7051-4dff-bfd2-e8881c280a78\",\n \"name\": \"Order 6 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20251204\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ],\n \"notes\": \"Order replaced via API\",\n \"serviceTimeSec\": 900,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n }\n },\n {\n \"id\": \"e8b1c0b7-1a1b-4504-bf99-d989e0babd56\",\n \"name\": \"Order 1 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20251205\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {},\n \"pickup\": null,\n \"delivery\": {\n \"depotId\": null,\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 30600,\n \"endSec\": 37800\n }\n ],\n \"notes\": \"removed one time window and restricted eligibility to one day\",\n \"serviceTimeSec\": 600,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {}\n },\n \"isService\": false\n }\n ],\n \"acceptBadGeocodes\" : true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "orders" ] } }, "response": [] } ] }, { "name": "Simulations", "item": [ { "name": "List Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders?include=all", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ], "query": [ { "key": "include", "value": "all" } ] } }, "response": [] }, { "name": "Get Orders (querystring)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders?ids=3b7df97f-481d-4511-b936-c81e465d18bf,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ], "query": [ { "key": "ids", "value": "3b7df97f-481d-4511-b936-c81e465d18bf,daf08435-57fa-4ae0-a579-9d5aa022a93c,bfdb8e20-e1d3-4951-b9b7-281babd338e6" } ] } }, "response": [] }, { "name": "Add Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"strict\": false,\n \"acceptBadGeocodes\": true,\n \"orders\": [\n {\n \"name\": \"Delivery-type Order at address to be geocoded\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Pickup-type Order at address to be geocoded\",\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Service-type Order at address to be geocoded (service-type orders are just delivery-type Orders flagged as 'isService'\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n },\n \"isService\": true\n },\n {\n \"name\": \"Pickup&Delivery-type Order at addresses to be geocoded\",\n \"loads\": {\n \"pounds\": 100\n },\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Pickup&Delivery-type Order with pickup at a depot and delivery at an address to be geocoded\",\n \"loads\": {\n \"pounds\": 100\n },\n \"pickup\": {\n \t\"depotId\": \"enter-a-valid-depot-id-here--use-list-depots-to-get-depot-ids\",\n \"serviceTimeSec\": 180\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"serviceTimeSec\": 1200\n }\n },\n {\n \"name\": \"Delivery w/ latitude&longitude (faster, no geocode necessary)\",\n \"delivery\": {\n \"location\": {\n \"address\": \"What's written here should still be a valid address, even if that's not strictly required as no geocoding takes place when latLng is specified\",\n\t\t \"latLng\": [\n\t\t \t45479039,\n\t\t 9222647\n\t\t ]\n }\n }\n },\n {\n \"name\": \"Delivery at generic address resulting in LOW ACCURACY geocode warning\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Milano\"\n },\n \"serviceTimeSec\": 540\n }\n },\n {\n \"name\": \"Delivery w/ TimeWindows Exceptions\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 57600,\n \"endSec\": 61200\n }\n ],\n \"timeWindowExceptions\": {\n \"20160627\": [\n {\n \"startSec\": 64800,\n \"endSec\": 68400\n }\n ],\n \"20160628\": [\n {\n \"startSec\": 30600,\n \"endSec\": 37800\n },\n {\n \"startSec\": 61200,\n \"endSec\": 64800\n }\n ]\n }\n }\n },\n {\n \"name\": \"Delivery at invalid address (NOT_FOUND)\",\n \"delivery\": {\n \"location\": {\n \"address\": \"vbieufbvikuafgadfga\"\n }\n }\n },\n { \n \"name\": \"Delivery requiring a specific vehicle\",\n \"forceVehicleId\": \"enter-a-valid-vehicle-id-here--use-list-vehicles-to-get-vehicle-ids\",\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery by a specific date\",\n \"eligibility\": {\n \"type\": \"by\",\n \"byDate\": \"20171031\"\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery on specific dates\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\"20171031\", \"20171101\", \"20171102\"]\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n }\n }\n },\n { \n \"name\": \"Delivery specifying all supported Order and OrderStep fields\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\"20171031\", \"20171101\", \"20171102\"]\n },\n \"forceVehicleId\": null,\n \"priority\": 20,\n \"loads\": {\n \"pounds\": 100,\n \"oranges\": 50,\n \"apples\": 200,\n \"people\": 12\n },\n \"pickup\": null,\n \"delivery\": {\n \t\"depotId\": null,\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 32400,\n \"endSec\": 36000\n },\n {\n \"startSec\": 54000,\n \"endSec\": 64800\n }\n ],\n \"timeWindowExceptions\": {},\n \"notes\": \"some notes here\",\n \"serviceTimeSec\": 600,\n \"tagsIn\": [\"large_truck\", \"two_men_teams\"],\n \"tagsOut\": [\"yellow_truck\"],\n \"customFields\": {\n \"custom1\": \"custom1val\",\n \"custom2\": \"custom2val\"\n }\n },\n \"isService\": false\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ] } }, "response": [] }, { "name": "Replace Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Order 6 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20250104\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 540, 20133, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ],\n \"notes\": \"Order replaced via API\",\n \"serviceTimeSec\": 900,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n },\n \"acceptBadGeocodes\" : true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Update Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "\n{\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Camillo Golgi 5400, 20133, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ]\n },\n \"acceptBadGeocodes\" : true\n}\n\n" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Update Orders", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"strict\": false,\n \"orders\": [\n {\n \"id\": \"27bfa2d4-8edf-4f65-8f18-5b61c494e323\",\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ],\n \"notes\": \"ok\"\n }\n },\n {\n \"id\": \"e0949352-2441-4d8e-9b9d-1b62a9047966\",\n \"delivery\": {\n \"serviceTimeSec\": 600,\n \"notes\": \"ok too\"\n }\n }\n ],\n \"acceptBadGeocodes\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ] } }, "response": [] }, { "name": "Replace OrderStep", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\r\n \"location\": {\r\n \"address\": \"Via Camillo Golgi 54, 20133, Milano, Italy\"\r\n },\r\n \"timeWindows\": [\r\n {\r\n \"startSec\": 22000,\r\n \"endSec\": 64000\r\n }\r\n ],\r\n \"notes\": \"Delivery OrderStep replaced via API\",\r\n \"serviceTimeSec\": 0,\r\n \"tagsIn\": null,\r\n \"tagsOut\": null,\r\n \"customFields\": {\r\n \"custom3\": \"custom3val\"\r\n }\r\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders/{{wwrm-orderId}}/delivery", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders", "{{wwrm-orderId}}", "delivery" ] } }, "response": [] }, { "name": "Delete Order", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders/{{wwrm-orderId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders", "{{wwrm-orderId}}" ] } }, "response": [] }, { "name": "Delete Orders", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n\t\"ids\": [\n\t\t\"108b4e4f-715c-41b1-ab8e-d84e1d81fd1d\",\n\t\t\"daf08435-57fa-4ae0-a579-9d5aa022a93c\",\n\t\t\"bfdb8e20-e1d3-4951-b9b7-281babd338e6\"\n\t]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ] } }, "response": [] }, { "name": "Delete Orders (querystring)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders?ids=a275647b-33e4-46a2-a0a9-46c648e526c3,9d1dec60-48c8-4a4e-b89e-fa844b763cc1,4a248114-8b79-44ec-94b9-8de3e02620bc", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ], "query": [ { "key": "ids", "value": "a275647b-33e4-46a2-a0a9-46c648e526c3,9d1dec60-48c8-4a4e-b89e-fa844b763cc1,4a248114-8b79-44ec-94b9-8de3e02620bc" } ] }, "description": "Limited to 20 (safe) or 200 (max) UUIDs because of querystring size limits" }, "response": [] }, { "name": "Delete OrderStep", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders/{{wwrm-orderId}}/delivery", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders", "{{wwrm-orderId}}", "delivery" ] } }, "response": [] }, { "name": "Replace (multiple) Orders", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orders\": [\n {\n \"id\": \"27bfa2d4-8edf-4f65-8f18-5b61c494e323\",\n \"name\": \"Order 6 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20251204\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"people\": 6\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 43200,\n \"endSec\": 54000\n }\n ],\n \"notes\": \"Order replaced via API\",\n \"serviceTimeSec\": 900,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n }\n },\n {\n \"id\": \"e0949352-2441-4d8e-9b9d-1b62a9047966\",\n \"name\": \"Order 1 - Replaced\",\n \"eligibility\": {\n \"type\": \"on\",\n \"onDates\": [\n \"20251205\"\n ]\n },\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {},\n \"pickup\": null,\n \"delivery\": {\n \"depotId\": null,\n \"location\": {\n \"address\": \"Via Valentino Pasini 9, 20129, Milano, Italy\"\n },\n \"timeWindows\": [\n {\n \"startSec\": 30600,\n \"endSec\": 37800\n }\n ],\n \"notes\": \"removed one time window and restricted eligibility to one day\",\n \"serviceTimeSec\": 600,\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {}\n },\n \"isService\": false\n }\n ],\n \"acceptBadGeocodes\" : true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "orders" ] } }, "response": [] } ] } ] }, { "name": "Time Of Arrival API", "item": [ { "name": "Operations", "item": [ { "name": "List current Routes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/toa/routes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "toa", "routes" ] } }, "response": [] }, { "name": "Send ExecutionEvents", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"events\": [\n {\n \"type\": \"timeIn\",\n \"orderId\": \"1b2ef347-9015-47d3-8da9-aa5914677a13\",\n \"vehicleId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da\",\n \"orderStepType\": \"delivery\",\n \"date\": \"20170907\",\n \"data\": {\n \"sec\": 36000,\n \"latLng\": [\n 45439037,\n 10994428\n ]\n }\n },\n {\n \"type\": \"timeOut\",\n \"orderId\": \"1b2ef347-9015-47d3-8da9-aa5914677a13\",\n \"vehicleId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da\",\n \"orderStepType\": \"delivery\",\n \"date\": \"20170907\",\n \"data\": {\n \"sec\": 44000,\n \"latLng\": [\n 45439037,\n 10994428\n ]\n }\n },\n {\n \"type\": \"statusUpdate\",\n \"orderId\": \"1b2ef347-9015-47d3-8da9-aa5914677a13\",\n \"vehicleId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da\",\n \"orderStepType\": \"delivery\",\n \"date\": \"20170907\",\n \"data_2\": null,\n \"data\": {\n \"sec\": 41000,\n \"status\": \"done\"\n }\n },\n {\n \"type\": \"podNote\",\n \"orderId\": \"1b2ef347-9015-47d3-8da9-aa5914677a13\",\n \"vehicleId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da\",\n \"orderStepType\": \"delivery\",\n \"date\": \"20170907\",\n \"data\": {\n \"sec\": 41000,\n \"text\": \"note text here\"\n }\n },\n {\n \"type\": \"podDriverBarcodes\",\n \"orderId\": \"49269a16-479c-4531-8ffd-513b7ccd0621\",\n \"vehicleId\": \"0d8855e6-28a0-4e89-9c67-b44c66c39ba6\",\n \"orderStepType\": \"delivery\",\n \"date\": \"20151204\",\n \"data\": {\n \"sec\": 36863,\n \"driverBarcodes\": [\n {\n \"barcode\": \"1212\",\n \"barcodeStatus\": \"SCANNED\",\n \"sec\": 31091,\n \"latLng\": [\n 6849331,\n 79950290\n ],\n \"driverId\": \"149a7898-3960-48b1-a806-cd057734cff7\"\n }\n ]\n }\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/toa/executionevents", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "toa", "executionevents" ] } }, "response": [] }, { "name": "Download PoD", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/pod/{{wwrm_podToken}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "pod", "{{wwrm_podToken}}" ] } }, "response": [] }, { "name": "Get current Route", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/toa/routes/{{wwrm-routeId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "toa", "routes", "{{wwrm-routeId}}" ] } }, "response": [] } ] }, { "name": "Simulation", "item": [ { "name": "List current Routes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/toa/routes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "toa", "routes" ] } }, "response": [] }, { "name": "Get current Route", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/toa/routes/{{wwrm-routeId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "toa", "routes", "{{wwrm-routeId}}" ] } }, "response": [] } ] } ] }, { "name": "Approved Plans API", "item": [ { "name": "List approved Routes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/approved/routes?date={{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "approved", "routes" ], "query": [ { "key": "date", "value": "{{wwrm-date}}" } ] } }, "response": [] }, { "name": "Get approved Route", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/approved/routes/{{wwrm-routeId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "approved", "routes", "{{wwrm-routeId}}" ] } }, "response": [] }, { "name": "Approve Routes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/approved/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "approved", "{{wwrm-date}}" ] } }, "response": [] }, { "name": "Revoke Routes", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/approved/{{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "approved", "{{wwrm-date}}" ] } }, "response": [] } ] }, { "name": "Approved Plans API v2", "item": [ { "name": "List Approved Routes v2", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v2/territories/{{wwrm-territoryId}}/approved/routes?date={{wwrm-date}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v2", "territories", "{{wwrm-territoryId}}", "approved", "routes" ], "query": [ { "key": "date", "value": "{{wwrm-date}}" } ] } }, "response": [] }, { "name": "Revoke Routes v2", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"31656f79-cba7-4bcf-a959-e3fe3f7ca2a7-20151205\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v2/territories/{{wwrm-territoryId}}/approved", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v2", "territories", "{{wwrm-territoryId}}", "approved" ] } }, "response": [] }, { "name": "Get Approved Route v2", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}api/v2/territories/{{wwrm-territoryId}}/approved/routes/{{wwrm-routeId}}", "host": [ "{{wwrm-url}}api" ], "path": [ "v2", "territories", "{{wwrm-territoryId}}", "approved", "routes", "{{wwrm-routeId}}" ] } }, "response": [] }, { "name": "Approve Routes v2", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"31656f79-cba7-4bcf-a959-e3fe3f7ca2a7-20151204\",\n \"0d8855e6-28a0-4e89-9c67-b44c66c39ba6-20151204\",\n \"31656f79-cba7-4bcf-a959-e3fe3f7ca2a7-20151205\"\n ],\n \"strict\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v2/territories/{{wwrm-territoryId}}/approved", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v2", "territories", "{{wwrm-territoryId}}", "approved" ] } }, "response": [] } ] }, { "name": "Scheduling API", "item": [ { "name": "Operations", "item": [ { "name": "Build Routes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"20250106\",\n \"to\": \"20250106\"\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/buildroutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "buildroutes" ] } }, "response": [] }, { "name": "Fit-In Unassigned Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"20171031\",\n \"to\": \"20171031\",\n \"routeIds\": [\"492c1f4b-467d-4349-ae0a-0947f0baa4da-20250106\"],\n \"orderIds\": [\"7f946f58-0966-43d8-b1f4-ee5d23120f41\",\"0ea3ebeb-a8eb-4648-993e-5a18d950345e\"]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/fitin", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "fitin" ] } }, "response": [] }, { "name": "Sequential Fit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderSteps\": [\n {\n \"orderId\": \"1394db69-058a-42e8-8be5-5e9d1da5d83c\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"1394db69-058a-42e8-8be5-5e9d1da5d83c\",\n \"type\": \"pickup\"\n }\n ],\n \"dstRouteId\": \"cb1c9af3-dc1c-4749-8530-0c89f1b0aac6-20241113\"\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/experimental/sequentialfit", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "experimental", "sequentialfit" ] } }, "response": [] }, { "name": "Assign an OrderStep", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/assign/{{wwrm-orderId}}/{{wwrm-orderStepType}}/to/{{wwrm-routeId}}/after/{{wwrm-secondSinceMidnight}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "assign", "{{wwrm-orderId}}", "{{wwrm-orderStepType}}", "to", "{{wwrm-routeId}}", "after", "{{wwrm-secondSinceMidnight}}" ] } }, "response": [] }, { "name": "Assign Multiple OrderSteps", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderSteps\": [\n {\n \"orderId\": \"4ceeac80-008d-4012-ab38-97eddae900cd\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"55b4db9d-a71b-4f68-aca0-a07a98d70a8f\",\n \"type\": \"delivery\"\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/assign/to/{{wwrm-routeId}}/after/{{wwrm-secondSinceMidnight}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "assign", "to", "{{wwrm-routeId}}", "after", "{{wwrm-secondSinceMidnight}}" ] } }, "response": [] }, { "name": "Apply Sequences", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"sequences\": [\n {\n \"routeId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250107\",\n \"orderSteps\": [\n {\n \"orderId\": \"d655f065-b058-4e4d-bfe3-16ccb68b2e60\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"d655f065-b058-4e4d-bfe3-16ccb68b2e60\",\n \"type\": \"pickup\"\n }\n ]\n },\n {\n \"routeId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250107\",\n \"orderSteps\": [\n {\n \"orderId\": \"62d1fb32-7db2-48da-8d8d-40af891afb48\",\n \"type\": \"pickup\"\n },\n {\n \"orderId\": \"62d1fb32-7db2-48da-8d8d-40af891afb48\",\n \"type\": \"delivery\"\n }\n ]\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/applysequences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "applysequences" ] } }, "response": [] }, { "name": "Swap Routes", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"srcRouteId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250106\",\n \"dstRouteId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da-20250106\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/swaproutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "swaproutes" ] } }, "response": [] }, { "name": "Get Progress", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/scheduling/progress", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "scheduling", "progress" ] } }, "response": [] } ] }, { "name": "Simulations", "item": [ { "name": "Build Routes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"20250106\",\n \"to\": \"20250106\"\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/buildroutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "buildroutes" ] } }, "response": [] }, { "name": "Fit-In Unassigned Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"20171031\",\n \"to\": \"20171031\",\n \"routeIds\": [\"492c1f4b-467d-4349-ae0a-0947f0baa4da-20250106\"],\n \"orderIds\": [\"7f946f58-0966-43d8-b1f4-ee5d23120f41\",\"0ea3ebeb-a8eb-4648-993e-5a18d950345e\"]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/fitin", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "fitin" ] } }, "response": [] }, { "name": "Assign OrderStep", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/assign/{{wwrm-orderId}}/{{wwrm-orderStepType}}/to/{{wwrm-routeId}}/after/{{wwrm-secondSinceMidnight}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "assign", "{{wwrm-orderId}}", "{{wwrm-orderStepType}}", "to", "{{wwrm-routeId}}", "after", "{{wwrm-secondSinceMidnight}}" ] } }, "response": [] }, { "name": "Assign Multiple OrderSteps", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderSteps\": [\n {\n \"orderId\": \"4ceeac80-008d-4012-ab38-97eddae900cd\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"55b4db9d-a71b-4f68-aca0-a07a98d70a8f\",\n \"type\": \"delivery\"\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/assign/to/{{wwrm-routeId}}/after/{{wwrm-secondSinceMidnight}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "assign", "to", "{{wwrm-routeId}}", "after", "{{wwrm-secondSinceMidnight}}" ] } }, "response": [] }, { "name": "Apply Sequences", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"sequences\": [\n {\n \"routeId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250107\",\n \"orderSteps\": [\n {\n \"orderId\": \"d655f065-b058-4e4d-bfe3-16ccb68b2e60\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"d655f065-b058-4e4d-bfe3-16ccb68b2e60\",\n \"type\": \"pickup\"\n }\n ]\n },\n {\n \"routeId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250107\",\n \"orderSteps\": [\n {\n \"orderId\": \"62d1fb32-7db2-48da-8d8d-40af891afb48\",\n \"type\": \"pickup\"\n },\n {\n \"orderId\": \"62d1fb32-7db2-48da-8d8d-40af891afb48\",\n \"type\": \"delivery\"\n }\n ]\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/applysequences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "applysequences" ] } }, "response": [] }, { "name": "Swap Routes", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"srcRouteId\": \"a4365245-7104-40af-a6ae-d29498f03350-20250106\",\n \"dstRouteId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da-20250106\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/swaproutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "swaproutes" ] } }, "response": [] }, { "name": "Get Progress", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/progress", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "progress" ] } }, "response": [] }, { "name": "Sequential Fit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderSteps\": [\n {\n \"orderId\": \"1394db69-058a-42e8-8be5-5e9d1da5d83c\",\n \"type\": \"delivery\"\n },\n {\n \"orderId\": \"1394db69-058a-42e8-8be5-5e9d1da5d83c\",\n \"type\": \"pickup\"\n }\n ],\n \"dstRouteId\": \"cb1c9af3-dc1c-4749-8530-0c89f1b0aac6-20241113\"\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/experimental/sequentialfit", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "experimental", "sequentialfit" ] } }, "response": [] } ] } ] }, { "name": "Scheduling API v2", "item": [ { "name": "Operations", "item": [ { "name": "Unassign Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderIds\": [\n \"7f946f58-0966-43d8-b1f4-ee5d23120f41\"\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v2/territories/{{wwrm-territoryId}}/scheduling/unassign", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v2", "territories", "{{wwrm-territoryId}}", "scheduling", "unassign" ] } }, "response": [] } ] }, { "name": "Simulations", "item": [ { "name": "Unassign Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" } ], "body": { "mode": "raw", "raw": "{\n \"orderIds\": [\n \"7f946f58-0966-43d8-b1f4-ee5d23120f41\"\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v2/territories/{{wwrm-territoryId}}/simulation/{{wwrm_simulationId}}/scheduling/unassign", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v2", "territories", "{{wwrm-territoryId}}", "simulation", "{{wwrm_simulationId}}", "scheduling", "unassign" ] } }, "response": [] } ] } ] }, { "name": "Customer Notifications API", "item": [ { "name": "List OrderStep Notifications", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/notifications/orders/{{wwrm-orderId}}/{{wwrm-orderStepType}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "notifications", "orders", "{{wwrm-orderId}}", "{{wwrm-orderStepType}}" ] } }, "response": [] }, { "name": "List Orders Notifications", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/notifications/orders?from=2025-01-05T00%3A00%3A00Z&to=2025-01-06T00%3A00%3A00Z", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "notifications", "orders" ], "query": [ { "key": "from", "value": "2025-01-05T00%3A00%3A00Z" }, { "key": "to", "value": "2025-01-06T00%3A00%3A00Z" } ] } }, "response": [] } ] }, { "name": "Proposals API", "item": [ { "name": "Compute ProposalsSet", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"order\": {\n \"name\": \"Order coming from Proposals API\",\n \"loads\": {\n \"pounds\": 400\n },\n \"pickup\": {\n \"location\": {\n \"address\": \"Via dei Fontanili, 61, 20017 Rho MI, Italy\"\n },\n \"notes\": \"Order (pickup) for which we want to compute a set of proposals\",\n \"serviceTimeSec\": 1800,\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Giorgio Washington, 72, 20146 Milano, Italy\"\n },\n \"notes\": \"Order (delivery) for which we want to compute a set of proposals\",\n \"serviceTimeSec\": 1800,\n \"customFields\": {\n \"my custom field\": \"custom field content\",\n \"orderId\": \"abcd1234\"\n }\n },\n \"isService\": false\n },\n \"timeSlots\": [\n {\n \"pickupTimeWindows\": [\n {\n \"startSec\": 26714,\n \"endSec\": 30714\n }\n ],\n \"deliveryTimeWindows\": [\n {\n \"startSec\": 30714,\n \"endSec\": 41600\n }\n ],\n \"date\": \"20250107\"\n }\n ],\n \"overrideLockedRoutes\": true\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/experimental/proposals", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "experimental", "proposals" ] } }, "response": [] }, { "name": "Get ProposalsSet", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/experimental/proposals/{{wwrm-proposalId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "experimental", "proposals", "{{wwrm-proposalId}}" ] } }, "response": [] }, { "name": "List ProposalsSets", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/experimental/proposals", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "experimental", "proposals" ] } }, "response": [] }, { "name": "Delete ProposalsSet", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/experimental/proposals/{{wwrm-proposalId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "experimental", "proposals", "{{wwrm-proposalId}}" ] } }, "response": [] }, { "name": "Apply Proposal", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{wwrm-url}}/territories/{{wwrm-territoryId}}/experimental/proposals/{{wwrm-proposalId}}", "host": [ "{{wwrm-url}}" ], "path": [ "territories", "{{wwrm-territoryId}}", "experimental", "proposals", "{{wwrm-proposalId}}" ] } }, "response": [] } ] }, { "name": "Directions API", "item": [ { "name": "Get Directions", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"directions\": [\n {\n \"status\": \"CURRENT\",\n \"routeId\": \"492c1f4b-467d-4349-ae0a-0947f0baa4da-20250918\"\n },\n {\n \"status\": \"APPROVED\",\n \"routeId\": \"0d02967c-11df-4312-aef3-e503478e443a-20250826\"\n },\n {\n \"status\": \"CURRENT\",\n \"routeId\": \"1d6ab9e2-ab62-47eb-a95b-464a4087a8cf-20250826\"\n }\n ],\n \"languageCode\": \"en\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/directions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "directions" ] } }, "response": [] } ] }, { "name": "Recurrence API", "item": [ { "name": "List Get Recurrences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences" ] } }, "response": [] }, { "name": "Get Recurrences", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"6f7d69a1-ef46-424c-90ba-441add70a8d1\",\n \"33078866-4a8d-4597-8fd4-08723df45ecc\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences" ] } }, "response": [] }, { "name": "Update OrderTemplate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"orderTemplatesUpdate\": [\n {\n \"orderTemplate\": {\n \"name\": \"Order1-TemplateChange v101\",\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"ok\": 11\n },\n \"pickup\": null,\n \"delivery\": null,\n \"isService\": false,\n \"companyId\": null\n },\n \"recurrenceId\": \"2b40cb28-da5d-4341-930a-2c07ae615209\"\n },\n {\n \"orderTemplate\": {\n \"name\": \"1-StrictAddRec100\",\n \"forceVehicleId\": null,\n \"priority\": 0,\n \"loads\": {\n \"ok\": 11\n },\n \"pickup\": {\n \"notes\": null,\n \"serviceTimeSec\": 600,\n \"email\": null,\n \"phone\": null,\n \"location\": {\n \"address\": \"Flint Hl Rd, Troy, NC 27371, USA\",\n \"geoAddress\": \"Flint Hl Rd, Troy, NC 27371, USA\",\n \"status\": \"OK\",\n \"source\": \"EXTERNAL\",\n \"latLng\": [\n 35481042,\n -79961738\n ],\n \"rooftopLatLng\": null\n },\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"trackingData\": null,\n \"type\": \"p\"\n },\n \"delivery\": {\n \"notes\": null,\n \"serviceTimeSec\": 600,\n \"email\": null,\n \"phone\": null,\n \"location\": {\n \"address\": \"699-201 Horseshoe Bend Rd, Troy, NC 27371, USA\",\n \"geoAddress\": \"699-201 Horseshoe Bend Rd, Troy, NC 27371, USA\",\n \"status\": \"OK\",\n \"source\": \"EXTERNAL\",\n \"latLng\": [\n 35484829,\n -79942240\n ],\n \"rooftopLatLng\": null\n },\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"trackingData\": null,\n \"type\": \"d\"\n },\n \"isService\": false,\n \"companyId\": null\n },\n \"recurrenceId\": \"a9976e67-8cd3-445a-bfe7-89f75de478ff\"\n }\n ],\n \"acceptBadGeocodes\": false,\n \"strict\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences/ordertemplate", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences", "ordertemplate" ] } }, "response": [] }, { "name": "Update Recurrent Orders", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"recurrencesUpdate\": [\n {\n \"recurrenceId\": \"6f7d69a1-ef46-424c-90ba-441add70a8d1\",\n \"orderTemplate\": {\n \"name\": \"Updated_FromRest\"\n }\n },\n {\n \"orderTemplate\": {\n \"name\": \"Second Update\",\n \"priority\": 10,\n \"delivery\": {\n \"notes\": \"Ciao\"\n }\n },\n \"recurrenceId\": \"6f7d69a1-ef46-424c-90ba-441add70a8d1\",\n \"endType\": \"ON_DATE\",\n \"startingOrderId\": \"d526ba2a-936c-4e0b-974b-dc38664bf846\",\n \"endDate\": \"20260920\"\n }\n ],\n \"acceptBadGeocodes\": false,\n \"strict\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences/updaterecurrences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences", "updaterecurrences" ] } }, "response": [] }, { "name": "Convert To Recurrent", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"ordersToRepeat\": [\n {\n \"orderId\": \"20528596-7e5b-48bf-b645-747eb802c703\",\n \"recurrencePeriod\": {\n \"recurrenceType\": \"WEEKLY\",\n \"period\": 1,\n \"weekday\": 6\n },\n \"recurrenceEndType\": \"NEVER\",\n \"numOfRecurrences\": -1,\n \"endDate\": null,\n \"startDate\": null\n }\n ],\n \"strict\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences", "orders" ] } }, "response": [] }, { "name": "Delete Recurrences", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"recurrences\": [\n {\n \"id\": \"365802e1-f6b5-43ee-aaab-fe414922ba81\",\n \"endDate\": \"20250909\"\n },\n {\n \"id\": \"9e4c6c41-1b74-422f-a3f1-7f43c85d0b4d\",\n \"endDate\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences" ] } }, "response": [] }, { "name": "Generate Recurrent Orders", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences/orders", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences", "orders" ] } }, "response": [] }, { "name": "Add Recurrence", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"strict\": false,\n \"acceptBadGeocodes\": true,\n \"addRecurrencesList\": [\n {\n \"recurrencePeriod\": {\n \"recurrenceType\": \"DAILY\",\n \"period\": -1,\n \"weekday\": -1,\n \"cardinal\": 0,\n \"month\": -1,\n \"date\": null\n },\n \"orderTemplate\": {\n \"name\": \"Recurrence order1\",\n \"companyId\": null,\n \"priority\": 0,\n \"forceVehicleId\": null,\n \"loads\": {},\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Palazzo, 94, 25010 Montirone BS, Italy\",\n \"latLng\": [\n 45429950,\n 10246860\n ],\n \"rooftopLatLng\": [\n 45429740,\n 10246540\n ]\n },\n \"serviceTimeSec\": 600,\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"notes\": \"\"\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Alessandro Volta, 25020 Dello BS, Italy\",\n \"latLng\": [\n 45429350,\n 10107890\n ],\n \"rooftopLatLng\": [\n 45429350,\n 10107890\n ]\n },\n \"serviceTimeSec\": 600,\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"notes\": \"\"\n }\n },\n \"startDate\": \"20260415\",\n \"endDate\": null,\n \"numOfRecurrencesRequired\": 5,\n \"endType\": \"AFTER_NUMBER\"\n },\n {\n \"recurrencePeriod\": {\n \"recurrenceType\": \"DAILY\",\n \"period\": -1,\n \"weekday\": -1,\n \"cardinal\": 0,\n \"month\": -1,\n \"date\": null\n },\n \"orderTemplate\": {\n \"name\": \"Recurrence order2\",\n \"companyId\": null,\n \"priority\": 0,\n \"forceVehicleId\": null,\n \"loads\": {},\n \"pickup\": {\n \"location\": {\n \"address\": \"Via Palazzo, 94, 25010 Montirone BS, Italy\",\n \"latLng\": [\n 45429950,\n 10246860\n ],\n \"rooftopLatLng\": [\n 45429740,\n 10246540\n ]\n },\n \"serviceTimeSec\": 600,\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"notes\": \"\"\n },\n \"delivery\": {\n \"location\": {\n \"address\": \"Via Alessandro Volta, 25020 Dello BS, Italy\",\n \"latLng\": [\n 45429350,\n 10107890\n ],\n \"rooftopLatLng\": [\n 45429350,\n 10107890\n ]\n },\n \"serviceTimeSec\": 600,\n \"timeWindows\": [],\n \"timeWindowExceptions\": {},\n \"tagsIn\": [],\n \"tagsOut\": [],\n \"customFields\": {},\n \"notes\": \"\"\n }\n },\n \"startDate\": \"20260415\",\n \"endDate\": null,\n \"numOfRecurrencesRequired\": 5,\n \"endType\": \"AFTER_NUMBER\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences" ] } }, "response": [] }, { "name": "Convert To Non Recurrent", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"orderIds\": [\n \"20528596-7e5b-48bf-b645-747eb802c703\"\n ],\n \"strict\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/recurrences/orders/nonrecurrent", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "recurrences", "orders", "nonrecurrent" ] } }, "response": [] } ] }, { "name": "GPS Tracking API", "item": [ { "name": "List GPS Devices", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/gps/devices", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "gps", "devices" ] } }, "response": [] }, { "name": "List Current GPS Info", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/gps/devices/current", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "gps", "devices", "current" ] } }, "response": [] } ] }, { "name": "WebHook API", "item": [ { "name": "List WebHook Subscription", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/webhooksubscriptions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "webhooksubscriptions" ] } }, "response": [] }, { "name": "Add WebHook Subscription", "request": { "method": "POST", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"events\": [\n \"ORDER_UPDATED\"\n ],\n \"territoryIds\": [\n \"bd5508db-a548-4ad2-badb-76b1ea07ba50\"\n ],\n \"url\": \"https://webhook.site/69fbb8e7-cede-4460-9160-44c889dafe44\",\n \"hmacSecret\": \"abcd123\",\n \"enabled\": true,\n \"queueBy\": \"SUBSCRIPTION\",\n \"headers\": {\n \"testHeader\": \"testHeaderBody\"\n }\n },\n {\n \"events\": [],\n \"territoryIds\": [],\n \"url\": \"https://webhook.site/69fbb8e7-cede-4460-9160-44c889dafe44\",\n \"enabled\": false,\n \"queueBy\": \"TERRITORY\",\n \"headers\": {}\n }\n ]\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/webhooksubscriptions", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "webhooksubscriptions" ] } }, "response": [] }, { "name": "Update WebHook Subscription", "request": { "method": "PUT", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": false\n}" }, "url": { "raw": "{{wwrm-url}}/api/v1/webhooksubscriptions/{{wwrm-webhookSubscriptionId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "webhooksubscriptions", "{{wwrm-webhookSubscriptionId}}" ] } }, "response": [] }, { "name": "Delete WebHook Subscription", "request": { "method": "DELETE", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/webhooksubscriptions?ids={{wwrm-webhookSubscriptionId}}", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "webhooksubscriptions" ], "query": [ { "key": "ids", "value": "{{wwrm-webhookSubscriptionId}}" } ] } }, "response": [] } ] }, { "name": "KPI API", "item": [ { "name": "route", "item": [ { "name": "dispatched", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/route/dispatched?from=20250601&to=20250605&durationFormat=Minutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "route", "dispatched" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" }, { "key": "durationFormat", "value": "Minutes", "type": "text" } ] } }, "response": [] }, { "name": "executed", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/route/executed?from=20250601&to=20250605&durationFormat=Minutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "route", "executed" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" }, { "key": "durationFormat", "value": "Minutes" } ] } }, "response": [] } ] }, { "name": "order", "item": [ { "name": "status", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/order/status?from=20250601&to=20250605", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "order", "status" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" } ] } }, "response": [] }, { "name": "ETA", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/order/eta?from=20250601&to=20250605", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "order", "eta" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" } ] } }, "response": [] }, { "name": "servicetime", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/order/servicetime?from=20250601&to=20250605", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "order", "servicetime" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" } ] } }, "response": [] } ] }, { "name": "driver", "item": [ { "name": "dispatched", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/driver/dispatched?from=20250601&to=20250605&durationFormat=Minutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "driver", "dispatched" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" }, { "key": "durationFormat", "value": "Minutes", "type": "text" } ] } }, "response": [] }, { "name": "executed", "request": { "method": "GET", "header": [ { "key": "X-WorkWave-Key", "value": "{{wwrm-api-key}}" }, { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{wwrm-url}}/api/v1/territories/{{wwrm-territoryId}}/kpi/driver/executed?from=20250601&to=20250605&durationFormat=Minutes", "host": [ "{{wwrm-url}}" ], "path": [ "api", "v1", "territories", "{{wwrm-territoryId}}", "kpi", "driver", "executed" ], "query": [ { "key": "from", "value": "20250601" }, { "key": "to", "value": "20250605" }, { "key": "durationFormat", "value": "Minutes", "type": "text" } ] } }, "response": [] } ] } ] } ] }