Changelog

Upstream changes

These changes have been released directly on the current version of the API because they preserve backwards compatibility.

  • The package object has a new client_reference field to store any ID on the client side, eg. a barcode.
  • The package object contains all the usefull information to describe it: name, volume, weight, temperature and fragility
  • The Package object can be created providing the name, volume and weight instead of the package_type_id
  • The Task object contains a completion_text field, which may contain a piece of information configured by the messenger company.
  • Rate limiting to 20 requests/second has been added to protect the platform
  • The Task object contains a eta field, which may contain the current estimated time of arrival company.
  • The redelivery endpoint has been added to allow the client to request a redelivery of a failed delivery.

Migrating from v1

V2 has been released on July 10th, 2023. The API v1 has been shut down on May 23rd, 2024.

Here are the main changes:

  • Timeslots: complete_after and complete_before are no longer used on the delivery. Please use slot_starting_at and slot_ending_at on the tasks (pickup and/or dropoff) instead.
  • Packages are no longer sent by their names but by id. You may retrieve your package types list using the API.
  • The API is no longer available at pedalo.olvo.fr, please use www.cyke.io

If you need to have a look at the API v1, you can access the documentation there.


This site uses Just the Docs, a documentation theme for Jekyll.