try out ↗

← API Index


/api/getdepots1

The public depots (pickup stations) that can serve a given location, each with its address, its tour and the next delivery date of that tour. Returns empty lists when the shop does not offer depots.

Change Note: replaces /api/getdepots: typed response, Address v22 instead of v12, ShopDate v8 instead of v7

Parameters

Name Description Type
lat latitude of the location to search from double
lng longitude of the location to search from double
invcode invitation code; if given, only depots carrying that code are returned 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 2 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 and by the depot lookup.
Address 22 A delivery address with geo-coordinates and delivery hints, extended with driver tour-plan info (translated hints, box placement position).
ShopDate 8 A delivery date with order, tour, shipping, and address information

OpenAPI

See getdepots1.yaml

Referenced in skills