Collectors

POS register (collector) management — create, list, control and update

List collectors (registers)

get

/collectors/list

Returns all POS registers (collectors) for the authenticated merchant.

Roles: Manager, SuperManager, Cashier

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Query parameters

childManagerstringOptional

Filter by child manager ID (SuperManager only)

Responses

200

List of collectors

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

get/collectors/list

GET /api/next/collectors/list HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "identifier": "text",
      "name": "text",
      "active": true,
      "salePoint": "text",
      "uuid": "text",
      "cashiers": [
        "text"
      ]
    }
  ]
}

Get a collector

get

/collectors/{id}

Returns details of a single collector by ID.

Roles: Manager, SuperManager, SuperAdmin, Service

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Collector ID

Responses

200

Collector details

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

404

Not found

get/collectors/{id}

GET /api/next/collectors/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "identifier": "text",
    "name": "text",
    "active": true,
    "salePoint": "text",
    "uuid": "text",
    "cashiers": [
      "text"
    ]
  }
}

Add a collector (register)

post

/collectors/add

Registers a new POS device as a collector. The uuid is scanned from the Lyzi ProScan app QR code.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Body

identifierstringRequired

Human-readable register identifier

salePointstringRequired

ID of the parent sale point

uuidstringRequired

UUID from the Lyzi ProScan app QR code

childManagerstringOptional

SuperManager: assign to a specific child manager

Responses

200

Collector added

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

422

Validation error

application/json

post/collectors/add

POST /api/next/collectors/add HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "identifier": "text",
  "salePoint": "text",
  "uuid": "text",
  "childManager": "text"
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "identifier": "text",
    "name": "text",
    "active": true,
    "salePoint": "text",
    "uuid": "text",
    "cashiers": [
      "text"
    ]
  }
}

Control collector (app login)

post

/collectors/controlcollector

Called by the Lyzi Pro app to authenticate a POS device and return a refreshed session. Validates the collector by identifier and updates its device info.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Body

identifierstringRequired

Collector identifier (UUID-BRANDNAME-COMPANYNAME-GEN format)

osstringRequired

Operating system (iOS/Android)

osVersionstringRequired

deviceModelstringRequired

deviceTokenstringRequired

FCM push notification token

Responses

200

Collector authenticated, updated collector object returned

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

404

Collector not found

422

Validation error

application/json

post/collectors/controlcollector

POST /api/next/collectors/controlcollector HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "identifier": "text",
  "os": "text",
  "osVersion": "text",
  "deviceModel": "text",
  "deviceToken": "text"
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "identifier": "text",
    "name": "text",
    "active": true,
    "salePoint": "text",
    "uuid": "text",
    "cashiers": [
      "text"
    ]
  }
}

Update a collector

put

/collectors/update/{id}

Updates the name, active status or assigned cashiers of a collector.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Collector ID

Body

namestringOptional

activebooleanOptional

cashiersstring[]Optional

List of cashier user IDs

Responses

200

Collector updated

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

422

Validation error

application/json

put/collectors/update/{id}

PUT /api/next/collectors/update/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "name": "text",
  "active": true,
  "cashiers": [
    "text"
  ]
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "identifier": "text",
    "name": "text",
    "active": true,
    "salePoint": "text",
    "uuid": "text",
    "cashiers": [
      "text"
    ]
  }
}

Get collectors by sale point

get

/collectors/salepoint/{id}

Returns all collectors (registers) attached to a specific sale point.

Roles: Manager, SuperManager, SimpleUser, SuperAdmin

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Sale point ID

Responses

200

Collectors for the sale point

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

get/collectors/salepoint/{id}

GET /api/next/collectors/salepoint/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "identifier": "text",
      "name": "text",
      "active": true,
      "salePoint": "text",
      "uuid": "text",
      "cashiers": [
        "text"
      ]
    }
  ]
}