Skip to content

Changelog

The Plotwise API is versioned. To reach a certain API version you can add the version in the URL as follows:

https://{root_url}/{api-version}/buckets/

API v2 is the only version currently available.

V2

API Version: v2
Status: New
Changelog:

  • Introduced Intermediate Depots
  • New fields introduced for Routes.
    • capacity_threshold
    • time_threshold
    • minimum_trip_length
    • intermediate_depot_duration
  • New fields introduced for Resources.
    • driver_capacity
    • vehicle_capacity
  • Route's algorithm_fields.capacity is replaced by driver_capacity and vehicle_capacity. Note: algorithm_fields of Resources is empty but still required.
  • break is now a separate type of Events, just like delivery and depot. Find out more here
  • type field is removed from algorithm_fields of Events in favor of a new optional field event_type. Find out more here
  • API v2 validation accepts fields that were available in API v1, but those fields are ignored. i.e will not be used in planing. For example, it is still possible to specify algorithm_fields.capacity of resource, but this value will be ignored. Planning will only taken into account the values of driver_capacity and vehicle_capacity.

Example URL request:

https://{root_url}/v2/buckets/

V1

API Version: v1
Status: Updated

Changelog:

  • Passing v2 fields to v1 API will cause validation errors.

Example URL request:

https://{root_url}/v1/buckets/

or 

  https://{root_url}/buckets/