Skip to main content
Sign in
Español Français

Smart appointment

  • Updated

💡Definition

Smart appointment scheduling is one of the three appointment scheduling methods offered by Woop. It is for carriers who optimise their routes via the Route Planner module and involves retrieving available delivery slots based on the actual capacity of the fleets used.

 

⚙️ Configuration

To use smart appointment scheduling, the following configurations are necessary:

1/ Configure the subscription at the carrier level

  • Go to the relevant "Carrier" profile
  • Click on the "Technical" tab
  • Add the "Appointment Scheduling" subscription
  • Enter the URL: http://woop-connector.woop/bookings

 

2/ Activate appointment scheduling at the brand/carrier level

  • Go to your "Brand" profile
  • Click on the relevant "Carrier"
  • Click on the "Technical" tab
  • Tick the "External appointment scheduling" option

 

3/ Configure the slot types:

  • Go to the relevant "Carrier" profile
  • Click on the "Delivery Network" tab
  • Set up the slot types according to the desired mode:
    • By duration/frequency
    • By time slots
  • For time slot types, there are two categories of slots available:
      • Standard: which appear by default when searching for available slots)
      • Premium: which appear only if requested via additional data (see below).

 

 

 

📝 Operation

Here are the different API calls that need to be made to book a smart slot:

 

1️⃣ post/timeSlot (here)

This first API call queries the optimisation engine to check the availability of each slot on the requested date range.

The required data in the body are:

  • The list of eligible carriers
  • The picking and delivery locations
  • The picking and delivery dates/times (see promise calculated in the previous step).
  • The order content (details of parcels and products)
  • The delivery services

⚠️ It is important to set the "promise" option to "true" to take into account the carriers' calendar constraints (cut-off, delivery times, activity periods, etc.).

💡 It is also possible to add "additional data" in the form of key/value pairs that will be transformed into parameters for the optimisation engine. The keys managed are:

  • OPTIONS = list of vehicle options (e.g. "Crane", "Tail lift", "Refrigerated", etc.)
  • SKILLS = list of driver skills (e.g. "Installation", etc.)
  • SLOT_CATEGORY = "Premium_first" = this allows you to retrieve only "premium" type slots AND for which it is possible to place the order first in a vehicle's route.

In response, the post/timeSlot returns for each carrier the list of available slots with an associated Id.

 

2️⃣ post/booking (here)

This second API call allows you to book the slot chosen by the end customer.

Simply push the slot Id provided in the previous step. In return, you get a booking Id. By default, the slot will be reserved for 30 minutes, but it is possible to adjust this time via the expiredAt field (up to a maximum of 100 days).

 

3️⃣ post/order (here)

This third and final API call allows you to create the transport order in Woop. You need to provide a valid booking Id to confirm the final reservation of the slot.