← API Index


Tour (v8)

A delivery tour in the admin/operator tour overview, including geo polygons and address counts.

Change Note: adds active (number of visible delivery addresses of active customers)

# Field Type Description
0 tourid int unique tour id
1 id string tour name (legacy identifier)
2 note string tour description or note
3 zipcodes string comma-separated zip code areas this tour is bound to (empty if unrestricted)
4 drivernote string driver-visible note for the tour
5 next_date date next delivery date on this tour (not provided in this overview, always empty)
6 hidden bool true if the tour is not visible/available to customers
7 incomplete bool true if the tour data is incomplete (e.g. geocoding of its addresses)
8 color string display color for maps/plans
9 poly string geo polygon of the tour area (encoded string, empty if none)
10 poly1 string alternative geo polygon of the tour area (encoded string, empty if none)
11 company bool true if this is a company-only tour
12 haspoly bool true if a polygon is defined (poly may be omitted if mp=0)
13 haspoly1 bool true if the alternative polygon is defined
14 cnt int number of delivery addresses assigned to this tour (includes inactive customers and invisible addresses)
15 visible bool true if the tour is currently visible in the shop
16 bike bool true if this tour is delivered by bike
17 active int number of active delivery addresses on this tour (visible addresses belonging to active customers)

Used in endpoints

Other versions