Shops

PATCH/v1/shops/{id}/place

Change where a shop stands and who shops there: its address, its notes, whether the public walks in.

What it does

The shop page's "Who shops here" form. Needs the sheet ability over the whole shop. Every field is optional, and a field left out stays as it is. A changed address is looked up on OpenStreetMap unless you send a pin; a place closed to the public is never looked up and keeps no pin. Written to the audit log.

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
PATCH https://panlytics.net/api/v1/shops/{id}/place

Parameters

NameInTypeRequiredWhat it is
idpathintegerYesThe shop's id.
AuthorizationheaderstringYesBearer, a space, then the key.

Body

Sent as application/json.

FieldTypeRequiredWhat it is
countrystringNoThe country. Left out, it stays as it is.
citystringNoThe city. Left out, it stays as it is.
areastringNoThe street or district, which the app calls the branch. Left out, it stays as it is.
notesstringNoWho shops here, in the company's own words. Left out, it stays as it is.
aboutstringNoAnything else worth knowing about the shop. Left out, it stays as it is.
openToPublicbooleanNoTrue for a shop people walk into, false for a warehouse or a stockroom. A place closed to the public is never looked up on a map and keeps no pin.
pinobjectNoA pin you already have, such as one read from a map link. Without it, a changed address is looked up on OpenStreetMap.
pin.latnumberYesLatitude.
pin.lonnumberYesLongitude.
pin.labelstringYesThe address as the map gave it.

Example request

curl -X PATCH https://panlytics.net/api/v1/shops/12/place \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "city": "Helsinki",
  "area": "Satamakatu 1",
  "notes": "Ferry passengers and office workers at lunch."
}'

Response

200: The answer, as JSON.

FieldTypeAlways thereWhat it is
shopobjectYesThe shop as it stands now.
shop.idintegerYesThe shop's id.
shop.namestringYesWhat the shop is called, as people in the company say it.
shop.branchstringYesThe branch name, or empty.
shop.citystringYesThe city the shop is in.
shop.countrystringYesThe country the shop is in, or empty.
shop.createdAtstring (ISO 8601)YesWhen the shop was made, in UTC.
shop.givenNamestringYesThe name the shop was opened under. Equal to name until somebody renames it.
shop.kindstring: manual, shopify, netvisorYesWhat feeds the shop: manual (reports somebody uploads), shopify or netvisor.
shop.openToPublicbooleanYesTrue for a shop people walk into, false for a warehouse or a stockroom.
shop.notesstringYesWho shops here, in the company's own words, or empty.
shop.aboutstringYesAnything else worth knowing about this shop, or empty.
shop.profilestring or nullYesThe short summary of the area around the shop, when it has been researched. Null otherwise.
shop.placeobject or nullYesWhere the shop stands on the map, when it has a pin. Null otherwise.
shop.place.labelstringYesThe address as the map gave it.
shop.place.latnumberYesLatitude.
shop.place.lonnumberYesLongitude.
shop.archivedAtstring (ISO 8601) or nullYesWhen the shop was archived, in UTC. Null for an open shop.
mapNotestring or nullYesA sentence when the address saved but the map could not place it, or null.

Example response

200
{
  "shop": {
    "id": 12,
    "name": "Harbour",
    "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
  },
  "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.

StatusCodeWhenWhat to do
400api.invalidA 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.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe 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.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe 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.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
404not_found.saidNothing 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.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.