Skip to main content

Rides

Une Ride correspond à une annonce chez Cocolis. Vous trouverez plus de détails sur le modèle ici.

Le client​

Une fois le client authentifié, vous pouvez interagir sur les Rides de cette façon :

$rideClient = $client->getRideClient();

Récupérer toutes mes Rides​

Vous pouvez récupérer toutes vos Rides créées sous la forme d'un tableau de Cocolis\Api\Models\Ride :

$rides = $client->getRideClient()->mine();

Récupérer une Ride​

Vous pouvez récupérer une Ride créée sous la forme d'un objet Cocolis\Api\Models\Ride :

$ride = $client->getRideClient()->get(":id");

Annuler une Ride​

Vous pouvez annuler une Ride de cette façon :

$client->getRideClient()->remove($id);

Vérifier la possibilité de réaliser une Ride​

Vérifier si Cocolis sera disponible pour effectuer la livraison pour un trajet donné entre 2 points, avec l'option assurance si éligible.

$match = $client->getRideClient()->canMatch($zipfrom, $zipto, $volume, $value);
warning

Tous nos prix sont en centimes

Voici un exemple de réponse en JSON :

{
  "result": true,
  "estimated_prices": {
    "regular": 95500,
    "with_insurance": 96728
  },
  "insurance_detail": {
    "amount": 150100,
    "conditions_url": "https://sandbox.cocolis.fr/assurance/conditions-assurance-optionnelle-jusqu-a-3000.pdf"
  },
  "rider_count": 0
}

Cette réponse peut être ensuite exploitée de cette façon avec la librairie PHP :

$regular_price = $match->estimated_prices->regular;

Créer une Ride​

Vous pouvez créer une Ride comme dans l'exemple présenté ci-dessous (pour en savoir plus sur les paramètres cliquez ici) :

$params = [
    "description" => "Carcassonne vers Toulouse",
    "from_lat" => 43.212498,
    "to_lat" => 43.599120,
    "from_address" => "Carcassonne",
    "to_address" => "Toulouse",
    "from_lng" => 2.350351,
    "to_lng" => 1.444391,
    "from_is_flexible" => true,
    "from_pickup_date" => "2020-06-13T14:21:21+00:00",
    "to_is_flexible" => true,
    "to_pickup_date" => "2020-06-13T14:21:21+00:00",
    "is_passenger" => false,
    "is_packaged" => false,
    "price" => 57000,
    "volume" => 15,
    ...
];
$rideClient = $client->getRideClient();
$ride = $rideClient->create($params);