Register a till

Any signed in user. Registers a device on a branch and returns its id, or the existing one. Only an admin may name another branch, and a retry returns the same device, not a second row.

POST/api/v1/sync/devices/register

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

device_idstring

branch_idstring

labelstring

Responses

200

The device was already registered

device_idstringrequired

branch_idstringrequired

labelstringrequired

201

Device registered

device_idstringrequired

branch_idstringrequired

labelstringrequired

401

Not authenticated

detailstringrequired

404

Branch not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

device_idstringbranch_idstringlabelstring

Request

curl -X POST 'http://localhost:8000/api/v1/sync/devices/register' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "device_id": "string",
  "branch_id": "string",
  "label": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/sync/devices/register", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"device_id\": \"string\",\n  \"branch_id\": \"string\",\n  \"label\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/sync/devices/register",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"device_id\": \"string\",\n  \"branch_id\": \"string\",\n  \"label\": \"string\"\n}",
)

Response

{
  "device_id": "string",
  "branch_id": "string",
  "label": "string"
}

{
  "device_id": "string",
  "branch_id": "string",
  "label": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}