Appearance
Create or update a lookup row โ
POST /v1/admin/store/lookups/{table}
- Operation ID:
upsertStoreLookup - Tags: Store lookups
- Base URL:
http://localhost:8787
Upserts by id (or code for languages). Extra columns are forwarded to the table when they exist. For tables with a slug, a missing slug is derived from name on create. Audited; emits a dashboard event.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission store.write.
Authentication โ
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
store.write
Parameters โ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
table | path | string | yes | One of: "genres", "companies", "platforms", "languages", "stores" |
Request body โ
Required: yes.
Content type: application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | no | Greater than: 0 |
code | string | no | - |
slug | string | no | - |
name | string | yes | Min length: 1. Max length: 200 |
Responses โ
201 โ
Saved row (both create and update return 201).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (StoreLookupItem)
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | no | Absent on languages (keyed by code). |
code | string | no | Languages only. |
slug | string | no | Absent on languages. |
name | string | yes | - |
website | string | null | no | Companies only. |
url | string | null | no | Stores only. |
icon_path | string | null | no | Stores only. |
created_at | string | no | ISO 8601 timestamp. |
updated_at | string | no | ISO 8601 timestamp. |
Errors โ
400 โ
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401 โ
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403 โ
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "store.write"
}
}500 โ
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples โ
curl โ
bash
curl -X POST 'http://localhost:8787/v1/admin/store/lookups/genres' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"id":1,"code":"example","slug":"example-game","name":"example"}'TypeScript โ
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/store/lookups/genres", {
method: "POST",
headers: {
"Authorization": `Bearer ${accessToken}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"id": 1,
"code": "example",
"slug": "example-game",
"name": "example"
}),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();