Shops

POST/v1/shops/{id}/locate

Look the shop's address up on OpenStreetMap again and pin it on the map.

What it does

The shop page's "Put me on the map" button. Needs the sheet ability over the whole shop. A place closed to the public is never looked up (409), a shop with no city or street has nothing to look up (400), and an address the map cannot find answers 404 and keeps no pin.

Who may call it

A key whose maker's role holds sheet (edit the sheet and upload a report), after the fence, for the shop or category it names.

Request

HTTP

POST https://panlytics.net/api/v1/shops/{id}/locate

Parameters

Name	In	Type	Required	What it is
`id`	path	integer	Yes	The shop's id.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

curl -X POST https://panlytics.net/api/v1/shops/12/locate \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.post(
    "https://panlytics.net/api/v1/shops/12/locate",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/shops/12/locate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
  },
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());

Response

200: The answer, as JSON.

Field	Type	Always there	What it is
`place`	object	Yes	Where the shop now stands on the map.
`place.label`	string	Yes	The address as the map gave it.
`place.lat`	number	Yes	Latitude.
`place.lon`	number	Yes	Longitude.
`mapNote`	string or null	Yes	A sentence about the lookup, or null.

Example response

200

{
  "place": {
    "label": "Satamakatu 1, Helsinki",
    "lat": 60.1675,
    "lon": 24.9566
  },
  "mapNote": null
}

Errors

A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.

Status	Code	When	What to do
400	`api.invalid`	A path id, a query parameter, a header or a body field is missing or not valid. `detail` names the field.	Read that endpoint in the API reference, correct the field and call again.
400	`bad_request.said`		Change it and try again.
401	`api.key_missing`	The call had no Authorization header.	Send the key in the Authorization header as Bearer, then call again.
401	`api.key_refused`	The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability).	Ask the person who gave you the key to make a new one.
401	`api.wrong_key_kind`	This key does not open these endpoints.	Use the key these endpoints were made for, or ask the person who gave you the key.
403	`refused`	The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach.	Ask the CEO for a role that allows it, or call it for a shop or category the role reaches.
403	`auth.not_fresh`	This step needs you to prove it is you.	Confirm your password or passkey, then try again.
404	`not_found.said`	Nothing with that id in the key's company. An id of another company answers the same.	Check the id. List the shop or category it belongs to and take the id from there.
409	`conflict.said`	The shop already has a supplier with that name.	Use another name, or change the supplier that has it.
429	`api.rate_limited`	The key made more than 120 calls in this minute. Wait the seconds in Retry-After.	Wait the seconds in Retry-After, then call again.
500	`server`	Something failed on our side. The answer carries a requestId to quote.	Try again in a minute; if it keeps happening, report it.
503	`developer.unavailable`	API keys are not set up on this deployment yet.	Report it, and we will switch them on.