Sign in

v15

latestOpenAPI 3.1.02026-07-1295183803.5 KB
Optimization

Re-optimization

post/optimization/re_optimization

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Request body

existing_request_idstring required

Specify the unique request ID that needs to be re-optimized.

locationsstring[]

Provide the list of locations to be used during re-optimization process. Please note that

  • Providing the location input overwrites the list of locations used in the original request.

  • The location_indexes associated with all tasks and vehicles (both from the original and new re-optimization input requests) will follow the updated list of locations.

As a best practice:

  1. Don't provide the locations input when re-optimizing, if the original set contains all the required location coordinates.

  2. If any new location coordinates are required for re-optimization, copy the full, original location list and update it in the following manner before adding it to the re-optimization input:

    1. Ensure to not update the indexes of locations which just need to be "modified".

    2. Add new location coordinates towards the end of the list.

Example request

{
  "job_changes": {
    "add": [
      {
        "id": "\"id\":\"Job 1\""
      }
    ],
    "modify": [
      {
        "id": "\"id\":\"Job 1\""
      }
    ]
  },
  "shipment_changes": {
    "add": [
      {
        "pickup": {
          "id": "\"id\": \"Shipment Pickup 1\""
        },
        "delivery": {
          "id": "\"id\":\"Shipment Delivery 1\""
        }
      }
    ],
    "modify": [
      {
        "pickup": {
          "id": "\"id\": \"Shipment Pickup 1\""
        },
        "delivery": {
          "id": "\"id\":\"Shipment Delivery 1\""
        }
      }
    ]
  }
}

Response

idstring

A unique ID which can be used in the Optimization GET method to retrieve the result of optimization.

messagestring

Displays an acknowledgement message once the job is submitted.

statusstring

A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages/codes are returned in case of errors. See the API Error Codes section below for more information.

warningsstring[]

Display the warnings for the given input parameters, values and constraints.