Shops

PATCH/v1/shops/{id}

Rename a shop: PATCH /v1/shops/{id} in the Panlytics API.

What it does

Needs the shops ability over the shop, as the app's rename does. The name the shop was opened under is kept and answered as givenName, so a rename never loses the old name.

Who may call it

A key whose maker's role holds shops (open, rename and archive shops, and connect their systems), after the fence, for the shop or category it names.

Request

HTTP

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

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.

Body

Sent as application/json.

Field	Type	Required	What it is
`name`	string	Yes	The name the company calls the shop now. The name it was opened under is kept as `givenName`.

Example request

curl -X PATCH https://panlytics.net/api/v1/shops/12 \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Harbour Market"
}'

import os

import requests

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

const response = await fetch("https://panlytics.net/api/v1/shops/12", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Harbour Market"
  }),
});
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
`id`	integer	Yes	The shop's id.
`name`	string	Yes	What the shop is called, as people in the company say it.
`branch`	string	Yes	The branch name, or empty.
`city`	string	Yes	The city the shop is in.
`country`	string	Yes	The country the shop is in, or empty.
`createdAt`	string (ISO 8601)	Yes	When the shop was made, in UTC.
`givenName`	string	Yes	The name the shop was opened under. Equal to `name` until somebody renames it.
`kind`	string: manual, shopify, netvisor	Yes	What feeds the shop: manual (reports somebody uploads), shopify or netvisor.
`openToPublic`	boolean	Yes	True for a shop people walk into, false for a warehouse or a stockroom.
`notes`	string	Yes	Who shops here, in the company's own words, or empty.
`about`	string	Yes	Anything else worth knowing about this shop, or empty.
`profile`	string or null	Yes	The short summary of the area around the shop, when it has been researched. Null otherwise.
`place`	object or null	Yes	Where the shop stands on the map, when it has a pin. Null otherwise.
`place.label`	string	Yes	The address as the map gave it.
`place.lat`	number	Yes	Latitude.
`place.lon`	number	Yes	Longitude.
`archivedAt`	string (ISO 8601) or null	Yes	When the shop was archived, in UTC. Null for an open shop.

Example response

200

{
  "id": 12,
  "name": "Harbour Market",
  "givenName": "Harbour",
  "branch": "",
  "city": "Helsinki",
  "country": "Finland",
  "createdAt": "2026-10-01T08:00:00.000Z",
  "kind": "manual",
  "openToPublic": true,
  "notes": "Students from the campus nearby, and families at the weekend.",
  "about": "A mid-sized grocery next to the ferry terminal.",
  "profile": null,
  "place": {
    "label": "Satamakatu 1, Helsinki",
    "lat": 60.1675,
    "lon": 24.9566
  },
  "archivedAt": 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.
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.
403	`refused.demo`	The key belongs to a shared demo account, which may not change anything.	Use a key made in a real company account.
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.
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.