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:

Don't provide the locations input when re-optimizing, if the original set contains all the required location coordinates.
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.

Changes

Changed in 4 of the 15 revisions of this API.4652

Jul 12, 2026b647f1808dda2See the full diff
- ▲
  the request property //// became required
  request-property-became-required
- ▲
  the request property /// became required
  request-property-became-required
Jul 31, 20257ee76f0ff6791616See the full diff
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 2025a800b73f11c11220See the full diff
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ○
  the request property default value changed from to " "
  request-property-default-value-changed
- ○
  the request property default value changed from to " "
  request-property-default-value-changed
- ○
  the request property default value changed from to " "
  request-property-default-value-changed
- ○
  the request property default value changed from to " "
  request-property-default-value-changed
- ○
  added the new " " enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new " " enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new " " enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new " " enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
Jul 30, 2025b79d96775b131616See the full diff
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value " " of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value fixed_bottom of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value parallel of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ▲
  removed the enum value strict of the request property ////
  request-property-enum-value-removed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  the request property default value changed from " " to
  request-property-default-value-changed
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new fixed_bottom enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new parallel enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added
- ○
  added the new strict enum value to the request property ////
  request-property-enum-value-added

Full history