try out ↗

← API Index


/api/findtour3

The delivery tours that can serve a given location, with the next delivery dates of each. Used to offer a new customer the tours and dates reachable at their address. Returns empty lists when nothing serves the location.

Change Note: replaces /api/findtour2: TourDistance v3 adds shipping

Parameters

Name Description Type
strategy how to look up the tour; -10 uses the shop setting newCustomerStrat. -1 by average distance, -2 by zip, -3 the configured new-customer tour, -4 by zip without wildcard, -5 polygons only, 0/1/2 by the tours of nearby customers int
lat latitude of the location to search from double
lng longitude of the location to search from double
zip zip code of the location; resolved from lat/lng when omitted string
invcode invitation code; if given, the tour is looked up by that code instead string
for_company tri-state company filter: omit = unknown; 1/true = only company tours (tours.company in 0,1); 0/false = only private tours (tours.company in 0,2, on PCG > 2026-07-01, otherwise treated as unknown) bool
shops comma separated list of shop variants (1,2,3) to consider string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
TourDistance 3 A delivery tour that can serve a given location, with how close it already comes to it. Emitted by the tour lookup for a new customer's address (findtour3).
ShopDate 8 A delivery date with order, tour, shipping, and address information

OpenAPI

See findtour3.yaml

Other versions